Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged

Conversation

heitorlessa
Copy link
Contributor

@heitorlessa heitorlessa commented Aug 29, 2022

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: write
      pages: write
    uses: ./.github/workflows/reusable_publish_docs.yml
    with:
      version: develop
      alias: 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 owner August 29, 2022 14:02
@heitorlessa heitorlessa requested review from leandrodamascena and removed request for a team August 29, 2022 14:02
@boring-cyborg boring-cyborg bot added the github-actions Pull requests that update Github_actions code label Aug 29, 2022
@pull-request-size pull-request-size bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Aug 29, 2022
@github-actions github-actions bot added the internal Maintenance changes label Aug 29, 2022
@heitorlessa heitorlessa 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
Copy link
Contributor

@rubenfonseca rubenfonseca left a comment

Choose a reason for hiding this comment

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

Makes sense, great job.

@heitorlessa heitorlessa 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-powertools aws-powertools deleted a comment from github-actions bot Aug 29, 2022
@aws-powertools aws-powertools deleted a comment from github-actions bot Aug 29, 2022
@aws-powertools aws-powertools deleted a comment from github-actions bot Aug 29, 2022
@heitorlessa heitorlessa 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-size pull-request-size bot 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:develop Aug 29, 2022
@heitorlessa heitorlessa deleted the chore/reusable-docs-workflow branch August 29, 2022 15:45
@aws-powertools aws-powertools deleted a comment from github-actions bot Aug 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
github-actions Pull requests that update Github_actions code internal Maintenance changes size/L Denotes 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