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

feat(docs): Move docs to S3 #2277

Merged
merged 5 commits into from
May 19, 2023
Merged

feat(docs): Move docs to S3 #2277

merged 5 commits into from
May 19, 2023

Conversation

sthulb
Copy link
Contributor

@sthulb sthulb commented May 16, 2023

Issue number:

Summary

As the project changes, we want to host our documentation on our own domain, this frees us of GitHub Pages and related outages. After this change our docs will be hosted in two locations GH Pages and on docs.powertools.aws.dev, this is a middle step for further changes later.

Changes

Please provide a summary of what's being changed

This pull request adds some extra steps to the release docs process, it copies the generated docs to an S3 bucket.

User experience

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

Docs will be available in S3 and GH Pages

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: Simon Thulbourn <sthulb@users.noreply.github.com>
@sthulb sthulb added documentation Improvements or additions to documentation github_actions Pull requests that update GitHub Actions code labels May 16, 2023
@sthulb sthulb requested a review from a team as a code owner May 16, 2023 13:00
@sthulb sthulb requested review from leandrodamascena and removed request for a team May 16, 2023 13:00
@pull-request-size pull-request-size bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label May 16, 2023
@boring-cyborg boring-cyborg bot added the github-actions Pull requests that update Github_actions code label May 16, 2023
@github-actions github-actions bot added the feature New feature or functionality label May 16, 2023
@leandrodamascena leandrodamascena marked this pull request as draft May 16, 2023 13:09
update permissions to use id-token: write to support OIDC

Signed-off-by: Simon Thulbourn <sthulb@users.noreply.github.com>
@pull-request-size pull-request-size bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels May 16, 2023
add `id-token: write`

Signed-off-by: Simon Thulbourn <sthulb@users.noreply.github.com>
add `id-token: write`

Signed-off-by: Simon Thulbourn <sthulb@users.noreply.github.com>
@sthulb sthulb marked this pull request as ready for review May 19, 2023 08:07
Comment on lines +17 to +19
permissions:
id-token: write

Copy link
Contributor

Choose a reason for hiding this comment

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

Simon, we are trying to keep the permissions very granular in our worflows and I don't think this is necessary as you are adding this permission on the release-docs job. Have you tried without it?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It seems that if you don't have id-token: write on the caller, it won't pass it down – I kept getting a id-token should be none error

Copy link
Contributor

Choose a reason for hiding this comment

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

Thank you for the explanation, Simon! In the future we'll refactor this workflows and we can review this.

@leandrodamascena leandrodamascena self-requested a review May 19, 2023 09:38
Copy link
Contributor

@leandrodamascena leandrodamascena left a comment

Choose a reason for hiding this comment

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

Great work, Simon! APPROVED!

Comment on lines +17 to +19
permissions:
id-token: write

Copy link
Contributor

Choose a reason for hiding this comment

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

Thank you for the explanation, Simon! In the future we'll refactor this workflows and we can review this.

@leandrodamascena leandrodamascena merged commit b3679c3 into develop May 19, 2023
4 checks passed
@leandrodamascena leandrodamascena deleted the s3-docs branch May 19, 2023 10:12
@github-actions github-actions bot added the pending-release Fix or implementation already in dev waiting to be released label May 24, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Jun 2, 2023

This is now released under 2.16.1 version!

@github-actions github-actions bot removed the pending-release Fix or implementation already in dev waiting to be released label Jun 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation feature New feature or functionality github_actions Pull requests that update GitHub Actions code github-actions Pull requests that update Github_actions code size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants