-
Notifications
You must be signed in to change notification settings - Fork 406
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
Conversation
Signed-off-by: Simon Thulbourn <sthulb@users.noreply.github.com>
update permissions to use id-token: write to support OIDC Signed-off-by: Simon Thulbourn <sthulb@users.noreply.github.com>
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>
permissions: | ||
id-token: write | ||
|
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
There was a problem hiding this 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!
permissions: | ||
id-token: write | ||
|
There was a problem hiding this comment.
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.
This is now released under 2.16.1 version! |
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
This pull request adds some extra steps to the release docs process, it copies the generated docs to an S3 bucket.
User experience
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:
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.