-
Notifications
You must be signed in to change notification settings - Fork 0
253 lines (214 loc) · 10.1 KB
/
release-actions.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
# Release Actions
# ==========================
# Reusable workflow that performs actions and workflows release.
# - Generates README for changed actions and workflows (documentation, versioning, etc.)
# - Commits and pushes the changes to the main branch
name: Release Actions
on:
workflow_call:
inputs:
runs-on:
description: "Json array of runner(s) to use. See https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job"
type: string
default: '["ubuntu-latest"]'
required: false
update-all:
description: "Update all actions and workflows, regardless of changes."
required: false
default: false
type: boolean
github-app-id:
description: "GitHub App ID to generate GitHub token in place of private-access-token. See https://github.com/actions/create-github-app-token"
required: false
type: string
secrets:
github-token:
description: "GitHub token for creating and merging pull request (permissions contents: write and pull-requests: write, workflows: write). See [actions/create-and-merge-pull-request](../../actions/create-and-merge-pull-request)"
github-app-key:
description: "GitHub App private key to generate GitHub token in place of github-token. See https://github.com/actions/create-github-app-token"
permissions:
contents: read
jobs:
prepare-release:
runs-on: ${{ fromJson(inputs.runs-on) }}
outputs:
changed-actions: ${{ steps.get-changed-actions.outputs.result }}
changed-workflows: ${{ steps.get-changed-workflows.outputs.result }}
latest-tag: ${{ steps.get-latest-tag.outputs.tag }}
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- id: get-latest-tag
uses: actions-ecosystem/action-get-latest-tag@v1
- id: changed-files
if: ${{ inputs.update-all == false }}
uses: tj-actions/changed-files@v44.0.0
with:
files: |
./actions/*
./.github/workflows/*
dir_names_exclude_current_dir: true
- id: changed-variables
shell: bash
run: |
CHANGED_FILES="${{ steps.changed-files.outputs.all_changed_and_modified_files }}"
echo "changed-files=$CHANGED_FILES" >> "$GITHUB_OUTPUT"
CURRENT_WORKFLOW=$(echo "${{ github.workflow_ref }}" | sed "s|${{ github.repository }}/||g" | sed 's/@.*//g')
CURRENT_WORKFLOW_HAS_CHANGED=$([[ "$CHANGED_FILES" == *"$CURRENT_WORKFLOW"* ]] && echo "true" || echo "false")
UPDATE_ALL="${{ inputs.update-all }}"
FORCE_UPDATE=$([[ "$CURRENT_WORKFLOW_HAS_CHANGED" = "true" || "$UPDATE_ALL" = "true" ]] && echo "true" || echo "false")
echo "force-update=$FORCE_UPDATE" >> "$GITHUB_OUTPUT"
- id: get-changed-actions
shell: bash
run: |
CHANGED_FILES="${{ steps.changed-variables.outputs.changed-files }}"
FORCE_UPDATE="${{ steps.changed-variables.outputs.force-update }}"
CHANGED_ACTIONS=()
while read -r FILE; do
ACTION_HAS_CHANGED=$([[ "$CHANGED_FILES" == *"$FILE"* ]] && echo "true" || echo "false")
SHOULD_UPDATE_FILE=$([[ "$FORCE_UPDATE" = "true" || "$ACTION_HAS_CHANGED" = "true" ]] && echo "true" || echo "false")
echo "::debug::File $FILE has changed: $ACTION_HAS_CHANGED, should update file: $SHOULD_UPDATE_FILE"
if [ "$SHOULD_UPDATE_FILE" == "true" ]; then
CHANGED_ACTIONS+=("$(dirname "$FILE")")
fi
done < <(find actions -name "action.yml" -type f)
echo "::debug::Changed files: ${CHANGED_ACTIONS[*]}"
JSON_CHANGED_ACTIONS=$(jq --compact-output --null-input '$ARGS.positional' --args -- "${CHANGED_ACTIONS[@]}");
echo "result<<EOF" >> "$GITHUB_OUTPUT" && echo "$JSON_CHANGED_ACTIONS" >> "$GITHUB_OUTPUT" && echo "EOF" >> "$GITHUB_OUTPUT"
- id: get-changed-workflows
shell: bash
run: |
CHANGED_FILES="${{ steps.changed-variables.outputs.changed-files }}"
FORCE_UPDATE="${{ steps.changed-variables.outputs.force-update }}"
CHANGED_WORKFLOWS=()
for FILE in .github/workflows/*.yml; do
# Ignore internal workflows
if [[ $(basename "$FILE") == __* ]]; then
continue
fi
WORKFLOW_HAS_CHANGED=$([[ "$CHANGED_FILES" == *"$FILE"* ]] && echo "true" || echo "false")
SHOULD_UPDATE_FILE=$([[ "$FORCE_UPDATE" = "true" || "$WORKFLOW_HAS_CHANGED" = "true" ]] && echo "true" || echo "false")
echo "::debug::File $FILE has changed: $WORKFLOW_HAS_CHANGED, should update file: $SHOULD_UPDATE_FILE"
if [ "$SHOULD_UPDATE_FILE" == "true" ]; then
CHANGED_WORKFLOWS+=("$FILE")
fi
done
echo "::debug::Changed files: ${CHANGED_WORKFLOWS[*]}"
JSON_CHANGED_WORKFLOWS=$(jq --compact-output --null-input '$ARGS.positional' --args -- "${CHANGED_WORKFLOWS[@]}");
echo "result<<EOF" >> "$GITHUB_OUTPUT" && echo "$JSON_CHANGED_WORKFLOWS" >> "$GITHUB_OUTPUT" && echo "EOF" >> "$GITHUB_OUTPUT"
generate-actions-readme:
needs: prepare-release
runs-on: ${{ fromJson(inputs.runs-on) }}
if: ${{ needs.prepare-release.outputs.changed-actions != '[]' }}
strategy:
fail-fast: false
matrix:
action: ${{ fromJson(needs.prepare-release.outputs.changed-actions) }}
# FIXME: This is a workaround for having workflow ref. See https://github.com/orgs/community/discussions/38659
permissions:
contents: read
id-token: write
steps:
- uses: hoverkraft-tech/ci-github-common/actions/checkout@0.12.1
# FIXME: This is a workaround for having workflow ref. See https://github.com/orgs/community/discussions/38659
# jscpd:ignore-start
- id: oidc
uses: ChristopherHX/oidc@v3
- uses: actions/checkout@v4 # checks out called workflow
with:
path: ./self-workflow
repository: ${{ steps.oidc.outputs.job_workflow_repo_name_and_owner }}
ref: ${{ steps.oidc.outputs.job_workflow_repo_ref }}
# jscpd:ignore-end
- id: action-slug
uses: ./self-workflow/actions/slugify
with:
value: ${{ matrix.action }}
- name: 📖 Generate README
uses: bitflight-devops/github-action-readme-generator@v1.8.0
with:
action: ${{ matrix.action }}/action.yml
readme: ${{ matrix.action }}/README.md
repo: ${{ github.event.repository.name }}/${{ matrix.action }}
pretty: true
versioning_enabled: true
version_prefix: ""
version_override: ${{ needs.prepare-release.outputs.latest-tag }}
branding_as_title_prefix: true
env:
INPUT_SHOW_LOGO: "true"
- uses: actions/upload-artifact@v4
with:
name: changed-files-${{ steps.action-slug.outputs.value }}
path: ${{ github.workspace }}/**/${{ matrix.action }}/README.md
generate-workflows-readme:
needs: prepare-release
runs-on: ${{ fromJson(inputs.runs-on) }}
if: ${{ needs.prepare-release.outputs.changed-workflows != '[]' }}
strategy:
fail-fast: false
matrix:
workflow: ${{ fromJson(needs.prepare-release.outputs.changed-workflows) }}
# FIXME: This is a workaround for having workflow ref. See https://github.com/orgs/community/discussions/38659
permissions:
contents: read
id-token: write
steps:
- uses: hoverkraft-tech/ci-github-common/actions/checkout@0.12.1
# FIXME: This is a workaround for having workflow ref. See https://github.com/orgs/community/discussions/38659
# jscpd:ignore-start
- id: oidc
uses: ChristopherHX/oidc@v3
- uses: actions/checkout@v4 # checks out called workflow
with:
path: ./self-workflow
repository: ${{ steps.oidc.outputs.job_workflow_repo_name_and_owner }}
ref: ${{ steps.oidc.outputs.job_workflow_repo_ref }}
# jscpd:ignore-end
- id: workflow-slug
uses: ./self-workflow/actions/slugify
with:
value: ${{ matrix.workflow }}
- name: 📖 Generate README
id: generate-readme
run:
# Readme file is same name but without yml by .md extension
WORKFLOW_FILE="${{ matrix.workflow }}"
README_FILE="${WORKFLOW_FILE%.*}.md"
echo "readme-file=${README_FILE}" >> "$GITHUB_OUTPUT"
WORKFLOW_FULL_PATH="${{ github.repository }}/${WORKFLOW_FILE}"
sed -i "s|${WORKFLOW_FULL_PATH}@.*|${WORKFLOW_FULL_PATH}@${{ needs.prepare-release.outputs.latest-tag }}|g" "${README_FILE}"
- uses: actions/upload-artifact@v4
with:
name: changed-files-${{ steps.workflow-slug.outputs.value }}
path: ${{ github.workspace }}/**/${{ steps.generate-readme.outputs.readme-file }}
publish-actions-readme:
needs: [prepare-release, generate-actions-readme, generate-workflows-readme]
if: always() && (needs.prepare-release.outputs.changed-actions != '[]' || needs.prepare-release.outputs.changed-workflows != '[]')
runs-on: ${{ fromJson(inputs.runs-on) }}
permissions:
pull-requests: write
contents: write
actions: write
steps:
- uses: actions/checkout@v4
- uses: actions/download-artifact@v4
with:
pattern: changed-files-*
path: /
- uses: actions/create-github-app-token@v1
if: inputs.github-app-id
id: generate-token
with:
app-id: ${{ inputs.github-app-id }}
private-key: ${{ secrets.github-app-key }}
- uses: hoverkraft-tech/ci-github-common/actions/create-and-merge-pull-request@main
with:
github-token: ${{ steps.generate-token.outputs.token || secrets.github-token || github.token }}
branch: docs/actions-workflows-documentation-update
title: "docs: update actions and workflows documentation"
body: Update actions and workflows documentation
commit-message: |
docs: update actions and workflows documentation
[skip ci]