Skip to content

chore(ci): add step to publish docs to S3 #1468

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

Merged
merged 4 commits into from
May 19, 2023
Merged

chore(ci): add step to publish docs to S3 #1468

merged 4 commits into from
May 19, 2023

Conversation

sthulb
Copy link
Contributor

@sthulb sthulb commented May 17, 2023

Description of your changes

Adds a new storage location for docs when they’re generated. Three of the files changed are for permissions changes to ensure that the id-token has write privileges. This PR uses a new environment (Docs) that has already been created in the repo settings.

Related issues, RFCs

Issue number: #1467

Checklist

  • My changes meet the tenets criteria
  • I have performed a self-review of my own code
  • I have commented my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my change is effective and works
  • The PR title follows the conventional commit semantics

Breaking change checklist

Is it a breaking change?: NO

  • I have documented the migration process
  • I have added, implemented necessary warnings (if it can live side by side)

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.

@boring-cyborg boring-cyborg bot added the automation This item relates to automation label May 17, 2023
@pull-request-size pull-request-size bot added the size/M PR between 30-99 LOC label May 17, 2023
@boring-cyborg
Copy link

boring-cyborg bot commented May 17, 2023

Thanks a lot for your first contribution! Please check out our contributing guidelines and don't hesitate to ask whatever you need.
In the meantime, check out the #typescript channel on our AWS Lambda Powertools Discord: Invite link

@dreamorosi dreamorosi changed the title S3 docs chore(ci): add step to publish docs to S3 May 18, 2023
@dreamorosi dreamorosi self-requested a review May 18, 2023 09:55
@dreamorosi dreamorosi linked an issue May 18, 2023 that may be closed by this pull request
1 task
Copy link
Contributor

@dreamorosi dreamorosi left a comment

Choose a reason for hiding this comment

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

🚢

Thanks for the PR Simon!

@dreamorosi dreamorosi requested a review from am29d May 18, 2023 09:57
@dreamorosi
Copy link
Contributor

@am29d, can you please check if the steps added by Simon would publish the docs & api versions correctly?

I think yes, but I'd appreciate a second pair of eyes.

@dreamorosi dreamorosi merged commit 6d0ed9e into main May 19, 2023
@dreamorosi dreamorosi deleted the s3-docs branch May 19, 2023 10:13
@boring-cyborg
Copy link

boring-cyborg bot commented May 19, 2023

Awesome work, congrats on your first merged pull request and thank you for helping improve everyone's experience!

sthulb added a commit that referenced this pull request May 19, 2023
* add required steps and permissions

* update permissions for doc launching

* adds environment to the workflow file

* Update .github/workflows/reusable-publish-docs.yml

---------

Co-authored-by: Andrea Amorosi <[email protected]>
@sthulb sthulb mentioned this pull request May 19, 2023
9 tasks
@github-actions github-actions bot added the pending-release This item has been merged and will be released soon label May 19, 2023
@aws-powertools aws-powertools deleted a comment from github-actions bot Jun 9, 2023
@dreamorosi dreamorosi removed the pending-release This item has been merged and will be released soon label Jun 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automation This item relates to automation size/M PR between 30-99 LOC
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: Add new primary documentation location (beta)
2 participants