Skip to content

Commit 712c6c7

Browse files
BrandonRomanonywilken
BrandonRomano
authored and
nywilken
committed
docs: Upgrade plugin to integrations framework
1 parent 5ef9c22 commit 712c6c7

9 files changed

+645
-32
lines changed

‎.github/workflows/ensure-docs-compiled.yaml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Ensure Docs are Compiled
2+
on:
3+
push:
4+
jobs:
5+
ensure-docs-compiled:
6+
runs-on: ubuntu-latest
7+
steps:
8+
- name: Checkout 🛎
9+
uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab # v3.5.2
10+
- uses: actions/setup-go@fac708d6674e30b6ba41289acaab6d4b75aa0753 # v4.0.1
11+
- shell: bash
12+
run: make build-docs
13+
- shell: bash
14+
run: |
15+
if [[ -z "$(git status -s)" ]]; then
16+
echo "OK"
17+
else
18+
echo "Docs have been updated, but the compiled docs have not been committed."
19+
echo "Run 'make build-docs', and commit the result to resolve this error."
20+
exit 1
21+
fi
22+

‎.github/workflows/notify-integration-release-via-manual.yaml

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
name: Notify Integration Release (Manual)
2+
on:
3+
workflow_dispatch:
4+
inputs:
5+
version:
6+
description: "The release version (semver)"
7+
default: 0.0.1
8+
required: false
9+
branch:
10+
description: "A branch or SHA"
11+
default: 'main'
12+
required: false
13+
jobs:
14+
notify-release:
15+
runs-on: ubuntu-latest
16+
steps:
17+
- name: Checkout this repo
18+
uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c # v3.3.0
19+
with:
20+
ref: ${{ github.event.inputs.branch }}
21+
# Ensure that Docs are Compiled
22+
- uses: actions/setup-go@v4
23+
- shell: bash
24+
run: make build-docs
25+
- shell: bash
26+
run: |
27+
if [[ -z "$(git status -s)" ]]; then
28+
echo "OK"
29+
else
30+
echo "Docs have been updated, but the compiled docs have not been committed."
31+
echo "Run 'make build-docs', and commit the result to resolve this error."
32+
exit 1
33+
fi
34+
# Perform the Release
35+
- name: Checkout integration-release-action
36+
uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c # v3.3.0
37+
with:
38+
repository: hashicorp/integration-release-action
39+
path: ./integration-release-action
40+
- name: Notify Release
41+
uses: ./integration-release-action
42+
with:
43+
integration_identifier: 'packer/hashicorp/tencentcloud'
44+
release_version: ${{ github.event.inputs.version }}
45+
release_sha: ${{ github.event.inputs.branch }}
46+
github_token: ${{ secrets.GITHUB_TOKEN }}

‎.github/workflows/notify-integration-release-via-tag.yaml

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: Notify Integration Release (Tag)
2+
on:
3+
push:
4+
tags:
5+
- '*.*.*' # Proper releases
6+
- '*.*.*-*' # Pre releases
7+
jobs:
8+
notify-release:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- name: Checkout this repo
12+
uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c # v3.3.0
13+
with:
14+
ref: ${{ github.ref }}
15+
# Ensure that Docs are Compiled
16+
- uses: actions/setup-go@v4
17+
- shell: bash
18+
run: make build-docs
19+
- shell: bash
20+
run: |
21+
if [[ -z "$(git status -s)" ]]; then
22+
echo "OK"
23+
else
24+
echo "Docs have been updated, but the compiled docs have not been committed."
25+
echo "Run 'make build-docs', and commit the result to resolve this error."
26+
exit 1
27+
fi
28+
# Perform the Release
29+
- name: Checkout integration-release-action
30+
uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c # v3.3.0
31+
with:
32+
repository: hashicorp/integration-release-action
33+
path: ./integration-release-action
34+
- name: Notify Release
35+
uses: ./integration-release-action
36+
with:
37+
integration_identifier: 'packer/hashicorp/tencentcloud'
38+
release_version: ${{ github.ref_name }}
39+
release_sha: ${{ github.ref }}
40+
github_token: ${{ secrets.GITHUB_TOKEN }}

‎.web-docs/README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
The Tencent Cloud plugin provides the capability to build customized images based on an existing base images.
2+
3+
### Installation
4+
To install this plugin add this code into your Packer configuration and run [packer init](/packer/docs/commands/init)
5+
```hcl
6+
packer {
7+
required_plugins {
8+
tencentcloud = {
9+
version = "~> 1"
10+
source = "github.com/hashicorp/tencentcloud"
11+
}
12+
}
13+
}
14+
```
15+
16+
Alternatively, you can use `packer plugins install` to manage installation of this plugin.
17+
18+
```sh
19+
packer plugins install github.com/hashicorp/ansible
20+
```
21+
22+
### Components
23+
24+
#### Builders
25+
- [tencentcloud-cvm](/packer/integrations/hashicorp/tencentcloud/latest/components/builder/cvm) - The `tencentcloud-cvm` builder plugin provides the capability to build customized images based on an existing base images.

0 commit comments

Comments
 (0)