docs: Add additional workflow for rebuilding old versions of documentation #1371
Conversation
|
Kudos, SonarCloud Quality Gate passed!
|
Codecov ReportPatch and project coverage have no change.
❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more. Additional details and impacted files@@ Coverage Diff @@
## main #1371 +/- ##
=========================================
Coverage 78.57% 78.57%
Complexity 651 651
=========================================
Files 74 74
Lines 2506 2506
Branches 259 259
=========================================
Hits 1969 1969
Misses 455 455
Partials 82 82 ☔ View full report in Codecov by Sentry. |
scottgerring
changed the title
| @@ -0,0 +1,100 @@ | |||
| name: Rebuild old docs | |||
There was a problem hiding this comment.
| name: Rebuild old docs | |
| # | |
| # This workflow lets us rebuild and redeploy an old version of the documentation. | |
| # Running it manually, specify a version and a git commit hash to deploy to that labeled version of the documentation. | |
| # This can be used to either publish old versions of the documentation, or to replace the current version without cutting a release. | |
| # | |
| name: Rebuild old docs |
| type: string | ||
|
|
||
| permissions: | ||
| contents: write |
There was a problem hiding this comment.
Do we need contents or pages ?
| pip install -r docs/requirements.txt | ||
| - name: Setup doc deploy | ||
| run: | | ||
| git config --global user.name Docs deploy |
There was a problem hiding this comment.
Do we need to set this if we aren't comitting and pushing?
There was a problem hiding this comment.
Looking good! Couple of comments inline.
Could you also add a brief section beneath "Releasing a new version" on re-deploying existing documentation - e.g. if we want to push a doc fix?
powertools-lambda-java/docs/processes/maintainers.md
Lines 165 to 169 in be284e2
|
Hey @kozub i'll close this for now, and we can re-open it when we have time to revisit |
Issue #, if available:
#1239
This change is required only for rebuilding old documentation and publish it to S3. Should be reverted when job is done.
Checklist
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.