Skip to content

chore(ci): create reusable docs publishing workflow - #1482

Merged
heitorlessa merged 7 commits into
aws-powertools:developfrom
heitorlessa:chore/reusable-docs-workflow
Aug 29, 2022
Merged

chore(ci): create reusable docs publishing workflow#1482
heitorlessa merged 7 commits into
aws-powertools:developfrom
heitorlessa:chore/reusable-docs-workflow

Conversation

@heitorlessa

@heitorlessaheitorlessa commented Aug 29, 2022

Copy link
Copy Markdown
Contributor

Issue number:#1333

Summary

Changes

Please provide a summary of what's being changed

This PR breaks the multiple ways to build and publish user guide & API docs to prevent future mistakes. It migrates all manual docs steps to use the new reusable_publish_docs.yml workflow. This will make it easier to support v1 and v2 docs too.

release-docs:
permissions:
contents: writepages: writeuses: ./.github/workflows/reusable_publish_docs.ymlwith:
version: developalias: stage

User experience

Please share what the user experience looks like before and after this change

Checklist

If your change doesn't seem to apply, please leave them unchecked.

Is this a breaking change?

RFC issue number:

Checklist:

  • Migration process documented
  • Implement warnings (if it can live side by side)

Acknowledgment

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

Signed-off-by: heitorlessa <lessa@amazon.co.uk>
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
@heitorlessa
heitorlessa requested a review from a team as a code ownerAugust 29, 2022 14:02
@heitorlessa
heitorlessa requested review from leandrodamascena and removed request for a teamAugust 29, 2022 14:02
@boring-cyborgboring-cyborgBot added the github-actions Pull requests that update Github_actions code label Aug 29, 2022
@pull-request-sizepull-request-sizeBot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Aug 29, 2022
@github-actionsgithub-actionsBot added the internal Maintenance changes label Aug 29, 2022
@heitorlessaheitorlessa added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Aug 29, 2022

@rubenfonsecarubenfonseca left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense, great job.

@heitorlessaheitorlessa added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Aug 29, 2022
@aws-powertoolsaws-powertools deleted a comment from github-actionsBotAug 29, 2022
@aws-powertoolsaws-powertools deleted a comment from github-actionsBotAug 29, 2022
@aws-powertoolsaws-powertools deleted a comment from github-actionsBotAug 29, 2022
@heitorlessaheitorlessa added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Aug 29, 2022
@pull-request-sizepull-request-sizeBot removed the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Aug 29, 2022
@heitorlessa
heitorlessa merged commit acd7af1 into aws-powertools:developAug 29, 2022
@heitorlessa
heitorlessa deleted the chore/reusable-docs-workflow branch August 29, 2022 15:45
@aws-powertoolsaws-powertools deleted a comment from github-actionsBotAug 29, 2022
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

github-actionsPull requests that update Github_actions codeinternalMaintenance changessize/LDenotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@heitorlessa@rubenfonseca