Skip to content

Commit 6d3fcec

Browse files
authored
ci: bump docs version against master on patch releases (#10879)
1 parent ce1cf51 commit 6d3fcec

1 file changed

Lines changed: 49 additions & 9 deletions

File tree

.github/workflows/docs-bump-version.yml

Lines changed: 49 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ jobs:
130130
with:
131131
author: prowler-bot <179230569+prowler-bot@users.noreply.github.com>
132132
token: ${{ secrets.PROWLER_BOT_ACCESS_TOKEN }}
133-
base: master
133+
base: ${{ env.BASE_BRANCH }}
134134
commit-message: 'docs: Update version to v${{ env.PROWLER_VERSION }}'
135135
branch: docs-version-update-to-v${{ env.PROWLER_VERSION }}
136136
title: 'docs: Update version to v${{ env.PROWLER_VERSION }}'
@@ -221,11 +221,6 @@ jobs:
221221
with:
222222
egress-policy: audit
223223

224-
- name: Checkout repository
225-
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
226-
with:
227-
persist-credentials: false
228-
229224
- name: Calculate next patch version
230225
run: |
231226
MAJOR_VERSION=${NEEDS_DETECT_RELEASE_TYPE_OUTPUTS_MAJOR_VERSION}
@@ -250,7 +245,13 @@ jobs:
250245
NEEDS_DETECT_RELEASE_TYPE_OUTPUTS_PATCH_VERSION: ${{ needs.detect-release-type.outputs.patch_version }}
251246
NEEDS_DETECT_RELEASE_TYPE_OUTPUTS_CURRENT_DOCS_VERSION: ${{ needs.detect-release-type.outputs.current_docs_version }}
252247

253-
- name: Bump versions in documentation for patch version
248+
- name: Checkout master branch
249+
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
250+
with:
251+
ref: ${{ env.BASE_BRANCH }}
252+
persist-credentials: false
253+
254+
- name: Bump versions in documentation for master
254255
run: |
255256
set -e
256257
@@ -261,12 +262,12 @@ jobs:
261262
echo "Files modified:"
262263
git --no-pager diff
263264
264-
- name: Create PR for documentation update to version branch
265+
- name: Create PR for documentation update to master
265266
uses: peter-evans/create-pull-request@c0f553fe549906ede9cf27b5156039d195d2ece0 # v8.1.0
266267
with:
267268
author: prowler-bot <179230569+prowler-bot@users.noreply.github.com>
268269
token: ${{ secrets.PROWLER_BOT_ACCESS_TOKEN }}
269-
base: ${{ env.VERSION_BRANCH }}
270+
base: ${{ env.BASE_BRANCH }}
270271
commit-message: 'docs: Update version to v${{ env.PROWLER_VERSION }}'
271272
branch: docs-version-update-to-v${{ env.PROWLER_VERSION }}
272273
title: 'docs: Update version to v${{ env.PROWLER_VERSION }}'
@@ -282,3 +283,42 @@ jobs:
282283
### License
283284
284285
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
286+
287+
- name: Checkout version branch
288+
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
289+
with:
290+
ref: ${{ env.VERSION_BRANCH }}
291+
persist-credentials: false
292+
293+
- name: Bump versions in documentation for version branch
294+
run: |
295+
set -e
296+
297+
# Update prowler-app.mdx with current release version
298+
sed -i "s|PROWLER_UI_VERSION=\"${CURRENT_DOCS_VERSION}\"|PROWLER_UI_VERSION=\"${PROWLER_VERSION}\"|" docs/getting-started/installation/prowler-app.mdx
299+
sed -i "s|PROWLER_API_VERSION=\"${CURRENT_DOCS_VERSION}\"|PROWLER_API_VERSION=\"${PROWLER_VERSION}\"|" docs/getting-started/installation/prowler-app.mdx
300+
301+
echo "Files modified:"
302+
git --no-pager diff
303+
304+
- name: Create PR for documentation update to version branch
305+
uses: peter-evans/create-pull-request@c0f553fe549906ede9cf27b5156039d195d2ece0 # v8.1.0
306+
with:
307+
author: prowler-bot <179230569+prowler-bot@users.noreply.github.com>
308+
token: ${{ secrets.PROWLER_BOT_ACCESS_TOKEN }}
309+
base: ${{ env.VERSION_BRANCH }}
310+
commit-message: 'docs: Update version to v${{ env.PROWLER_VERSION }}'
311+
branch: docs-version-update-to-v${{ env.PROWLER_VERSION }}-branch
312+
title: 'docs: Update version to v${{ env.PROWLER_VERSION }}'
313+
labels: no-changelog,skip-sync
314+
body: |
315+
### Description
316+
317+
Update Prowler documentation version references to v${{ env.PROWLER_VERSION }} in version branch after releasing Prowler v${{ env.PROWLER_VERSION }}.
318+
319+
### Files Updated
320+
- `docs/getting-started/installation/prowler-app.mdx`: `PROWLER_UI_VERSION` and `PROWLER_API_VERSION`
321+
322+
### License
323+
324+
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

0 commit comments

Comments
 (0)