Skip to content

Commit f84b3c3

Browse files
hoverkraft-bot[bot]hoverkraft-bot[bot]
committed
docs: update actions and workflows documentation
[skip ci] Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent 91a69c7 commit f84b3c3

15 files changed

Lines changed: 87 additions & 96 deletions

‎.github/workflows/clean-deploy-argocd-app-of-apps.md‎

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,6 @@ Payload:
4646
### Permissions
4747

4848
- **`contents`**: `read`
49-
- **`id-token`**: `write`
5049
- **`pull-requests`**: `write`
5150

5251
<!-- overview:end -->
@@ -64,7 +63,7 @@ on:
6463
permissions: {}
6564
jobs:
6665
clean-deploy-argocd-app-of-apps:
67-
uses: hoverkraft-tech/ci-github-publish/.github/workflows/clean-deploy-argocd-app-of-apps.yml@b56be562f38e0e3e712f09691a8fe930aae9db1b # 0.22.0
66+
uses: hoverkraft-tech/ci-github-publish/.github/workflows/clean-deploy-argocd-app-of-apps.yml@91a69c7a9730d3ec2886a80681dbb67634c70970 # 0.23.1
6867
permissions: {}
6968
secrets:
7069
# GitHub token for creating and merging pull request (permissions contents: write and pull-requests: write, workflows: write).
@@ -81,9 +80,9 @@ jobs:
8180
# Default: `["ubuntu-latest"]`
8281
runs-on: '["ubuntu-latest"]'
8382

84-
# GitHub App ID to generate GitHub token in place of github-token.
83+
# GitHub App Client ID to generate GitHub token in place of github-token.
8584
# See https://github.com/actions/create-github-app-token.
86-
github-app-id: ""
85+
github-app-client-id: ""
8786
```
8887
8988
<!-- usage:end -->
@@ -94,12 +93,12 @@ jobs:
9493
9594
### Workflow Call Inputs
9695
97-
| **Input** | **Description** | **Required** | **Type** | **Default** |
98-
| ------------------- | ---------------------------------------------------------------------------------- | ------------ | ---------- | ------------------- |
99-
| **`runs-on`** | JSON array of runner(s) to use. | **false** | **string** | `["ubuntu-latest"]` |
100-
| | See <https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job>. | | | |
101-
| **`github-app-id`** | GitHub App ID to generate GitHub token in place of github-token. | **false** | **string** | - |
102-
| | See <https://github.com/actions/create-github-app-token>. | | | |
96+
| **Input** | **Description** | **Required** | **Type** | **Default** |
97+
| -------------------------- | ---------------------------------------------------------------------------------- | ------------ | ---------- | ------------------- |
98+
| **`runs-on`** | JSON array of runner(s) to use. | **false** | **string** | `["ubuntu-latest"]` |
99+
| | See <https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job>. | | | |
100+
| **`github-app-client-id`** | GitHub App Client ID to generate GitHub token in place of github-token. | **false** | **string** | - |
101+
| | See <https://github.com/actions/create-github-app-token>. | | | |
103102

104103
<!-- inputs:end -->
105104

@@ -144,7 +143,7 @@ concurrency:
144143
145144
jobs:
146145
deploy:
147-
uses: hoverkraft-tech/ci-github-publish/.github/workflows/clean-deploy-argocd-app-of-apps.yml@b56be562f38e0e3e712f09691a8fe930aae9db1b # 0.22.0
146+
uses: hoverkraft-tech/ci-github-publish/.github/workflows/clean-deploy-argocd-app-of-apps.yml@91a69c7a9730d3ec2886a80681dbb67634c70970 # 0.23.1
148147
secrets:
149148
github-token: ${{ secrets.GITHUB_TOKEN }}
150149
github-app-key: ${{ secrets.GITHUB_APP_KEY }}

‎.github/workflows/clean-deploy.md‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,6 @@ Behavior / outputs:
4444

4545
- **`actions`**: `read`
4646
- **`deployments`**: `write`
47-
- **`id-token`**: `write`
4847
- **`issues`**: `write`
4948
- **`pull-requests`**: `write`
5049

@@ -63,7 +62,7 @@ on:
6362
permissions: {}
6463
jobs:
6564
clean-deploy:
66-
uses: hoverkraft-tech/ci-github-publish/.github/workflows/clean-deploy.yml@b56be562f38e0e3e712f09691a8fe930aae9db1b # 0.22.0
65+
uses: hoverkraft-tech/ci-github-publish/.github/workflows/clean-deploy.yml@91a69c7a9730d3ec2886a80681dbb67634c70970 # 0.23.1
6766
permissions: {}
6867
secrets:
6968
# GitHub token for deploying.
@@ -81,9 +80,9 @@ jobs:
8180
# Default: `["ubuntu-latest"]`
8281
runs-on: '["ubuntu-latest"]'
8382

84-
# GitHub App ID to generate GitHub token in place of github-token.
83+
# GitHub App Client ID to generate GitHub token in place of github-token.
8584
# See https://github.com/actions/create-github-app-token.
86-
github-app-id: ""
85+
github-app-client-id: ""
8786

8887
# Type of clean-deploy action.
8988
# Supported values:
@@ -121,7 +120,7 @@ jobs:
121120
| ----------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------ | ---------- | --------------------- |
122121
| **`runs-on`** | JSON array of runner(s) to use. | **false** | **string** | `["ubuntu-latest"]` |
123122
| | See <https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job>. | | | |
124-
| **`github-app-id`** | GitHub App ID to generate GitHub token in place of github-token. | **false** | **string** | - |
123+
| **`github-app-client-id`** | GitHub App Client ID to generate GitHub token in place of github-token. | **false** | **string** | - |
125124
| | See <https://github.com/actions/create-github-app-token>. | | | |
126125
| **`clean-deploy-type`** | Type of clean-deploy action. | **false** | **string** | `repository-dispatch` |
127126
| | Supported values: | | | |
@@ -178,7 +177,7 @@ permissions:
178177
179178
jobs:
180179
clean-deploy:
181-
uses: hoverkraft-tech/ci-github-publish/.github/workflows/clean-deploy.yml@b56be562f38e0e3e712f09691a8fe930aae9db1b # 0.22.0
180+
uses: hoverkraft-tech/ci-github-publish/.github/workflows/clean-deploy.yml@91a69c7a9730d3ec2886a80681dbb67634c70970 # 0.23.1
182181
with:
183182
clean-deploy-parameters: |
184183
{ "repository": "${{ github.repository_owner }}/argocd-app-of-apps" }

‎.github/workflows/deploy-argocd-app-of-apps.md‎

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,6 @@ Key Features:
6767
### Permissions
6868

6969
- **`contents`**: `read`
70-
- **`id-token`**: `write`
7170
- **`pull-requests`**: `write`
7271

7372
<!-- overview:end -->
@@ -85,7 +84,7 @@ on:
8584
permissions: {}
8685
jobs:
8786
deploy-argocd-app-of-apps:
88-
uses: hoverkraft-tech/ci-github-publish/.github/workflows/deploy-argocd-app-of-apps.yml@b56be562f38e0e3e712f09691a8fe930aae9db1b # 0.22.0
87+
uses: hoverkraft-tech/ci-github-publish/.github/workflows/deploy-argocd-app-of-apps.yml@91a69c7a9730d3ec2886a80681dbb67634c70970 # 0.23.1
8988
permissions: {}
9089
secrets:
9190
# GitHub token for creating and merging pull request (permissions contents: write and pull-requests: write, workflows: write).
@@ -106,9 +105,9 @@ jobs:
106105
# Default: `template.yml.tpl`
107106
template-filename: template.yml.tpl
108107

109-
# GitHub App ID to generate GitHub token in place of github-token.
108+
# GitHub App Client ID to generate GitHub token in place of github-token.
110109
# See https://github.com/actions/create-github-app-token.
111-
github-app-id: ""
110+
github-app-client-id: ""
112111
```
113112
114113
<!-- usage:end -->
@@ -129,13 +128,13 @@ on:
129128

130129
### Workflow Call Inputs
131130

132-
| **Input** | **Description** | **Required** | **Type** | **Default** |
133-
| ----------------------- | ---------------------------------------------------------------------------------- | ------------ | ---------- | ------------------- |
134-
| **`runs-on`** | JSON array of runner(s) to use. | **false** | **string** | `["ubuntu-latest"]` |
135-
| | See <https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job>. | | | |
136-
| **`template-filename`** | Filename of the template to use. | **false** | **string** | `template.yml.tpl` |
137-
| **`github-app-id`** | GitHub App ID to generate GitHub token in place of github-token. | **false** | **string** | - |
138-
| | See <https://github.com/actions/create-github-app-token>. | | | |
131+
| **Input** | **Description** | **Required** | **Type** | **Default** |
132+
| -------------------------- | ---------------------------------------------------------------------------------- | ------------ | ---------- | ------------------- |
133+
| **`runs-on`** | JSON array of runner(s) to use. | **false** | **string** | `["ubuntu-latest"]` |
134+
| | See <https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job>. | | | |
135+
| **`template-filename`** | Filename of the template to use. | **false** | **string** | `template.yml.tpl` |
136+
| **`github-app-client-id`** | GitHub App Client ID to generate GitHub token in place of github-token. | **false** | **string** | - |
137+
| | See <https://github.com/actions/create-github-app-token>. | | | |
139138

140139
<!-- inputs:end -->
141140

0 commit comments

Comments
 (0)