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

fix(docs): ensure versions.json is updated #2505

Merged
merged 6 commits into from
Jun 23, 2023
Merged

Conversation

sthulb
Copy link
Contributor

@sthulb sthulb commented Jun 20, 2023

Issue number: #2504

Summary

Changes

Please provide a summary of what's being changed

I've added a new stanza to reusable_publish_docs.yml to ensure the versions.json is created.

User experience

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

Before:
After a docs upload to S3, the version picker would be out of date.

After:
The version picker will contain the newest version number.

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.

@github-actions github-actions bot added the bug Something isn't working label Jun 20, 2023
Signed-off-by: Simon Thulbourn <sthulb@users.noreply.github.com>
@sthulb sthulb marked this pull request as draft June 20, 2023 15:12
sthulb added 2 commits June 20, 2023 17:22
Signed-off-by: Simon Thulbourn <sthulb@users.noreply.github.com>
Signed-off-by: Simon Thulbourn <sthulb@users.noreply.github.com>
@leandrodamascena leandrodamascena linked an issue Jun 20, 2023 that may be closed by this pull request
Signed-off-by: Simon Thulbourn <sthulb@users.noreply.github.com>
@boring-cyborg boring-cyborg bot added the github-actions Pull requests that update Github_actions code label Jun 23, 2023
@pull-request-size pull-request-size bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Jun 23, 2023
@sthulb sthulb marked this pull request as ready for review June 23, 2023 10:48
@sthulb sthulb requested a review from a team as a code owner June 23, 2023 10:48
@leandrodamascena leandrodamascena requested review from leandrodamascena and removed request for a team June 23, 2023 10:54
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.

Approved!

.github/workflows/reusable_publish_docs.yml Show resolved Hide resolved
@leandrodamascena leandrodamascena merged commit e5d0b1c into develop Jun 23, 2023
@leandrodamascena leandrodamascena deleted the doc-versions branch June 23, 2023 11:03
leandrodamascena added a commit to leandrodamascena/aws-lambda-powertools-python that referenced this pull request Jun 23, 2023
Co-authored-by: Leandro Damascena <lcdama@amazon.pt>
rafaelgsr pushed a commit to rafaelgsr/aws-lambda-powertools-python that referenced this pull request Jun 30, 2023
Co-authored-by: Leandro Damascena <lcdama@amazon.pt>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working github-actions Pull requests that update Github_actions code size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug: Docs doesn't upload versions.json when being updated
2 participants