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

Maintenance: Docs doesn't upload versions.json when being updated #1520

Closed
sthulb opened this issue Jun 20, 2023 · 3 comments · Fixed by #1521
Closed

Maintenance: Docs doesn't upload versions.json when being updated #1520

sthulb opened this issue Jun 20, 2023 · 3 comments · Fixed by #1521
Assignees
Labels
automation This item relates to automation completed This item is complete and has been merged/shipped internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.)

Comments

@sthulb
Copy link
Contributor

sthulb commented Jun 20, 2023

Expected Behaviour

When generating the docs and uploading to S3, the versions.json file should be updated

Current Behaviour

The action responsible for docs, doesn't generate the versions.json file

Code snippet

N/A

Steps to Reproduce

On release, observe the lack of versions.json file being upload

Possible Solution

No response

Powertools for AWS Lambda (TypeScript) version

latest

AWS Lambda function runtime

18.x

Packaging format used

Lambda Layers, npm

Execution logs

No response

@sthulb sthulb added bug Something isn't working triage This item has not been triaged by a maintainer, please wait labels Jun 20, 2023
@dreamorosi
Copy link
Contributor

My understanding is that this is managed by the mike command and that the file normally would be stored in the gh-pages branch and updated in memory by mike itself, before being committed.

I don't know if the utility is able to do the same with S3, if not we'll have to write an utility that gets the current file from S3, updates it, and uploads it again.


I'm changing the categorization of the issue to maintenance. Generally we try to keep feature requests and bugs only to Powertools utility related issues, all others are either maintenance (like this one) or documentation.

@dreamorosi dreamorosi added automation This item relates to automation internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) confirmed The scope is clear, ready for implementation and removed bug Something isn't working triage This item has not been triaged by a maintainer, please wait labels Jun 20, 2023
@dreamorosi dreamorosi changed the title Bug: Docs doesn't upload versions.json when being updated Maintenance: Docs doesn't upload versions.json when being updated Jun 20, 2023
@sthulb
Copy link
Contributor Author

sthulb commented Jun 20, 2023

I looked into mike before making the PR, as far as I can see, mike doesn't support anything other than GH Pages.

@dreamorosi dreamorosi linked a pull request Jun 20, 2023 that will close this issue
9 tasks
@dreamorosi dreamorosi moved this from Backlog to Shipped in Powertools for AWS Lambda (TypeScript) Jun 20, 2023
@github-project-automation github-project-automation bot moved this from Shipped to Coming soon in Powertools for AWS Lambda (TypeScript) Jun 20, 2023
@github-actions
Copy link
Contributor

⚠️ COMMENT VISIBILITY WARNING ⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

@github-actions github-actions bot added pending-release This item has been merged and will be released soon and removed confirmed The scope is clear, ready for implementation labels Jun 20, 2023
@dreamorosi dreamorosi added completed This item is complete and has been merged/shipped and removed pending-release This item has been merged and will be released soon labels Jun 20, 2023
@dreamorosi dreamorosi moved this from Coming soon to Shipped in Powertools for AWS Lambda (TypeScript) Jun 20, 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 completed This item is complete and has been merged/shipped internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.)
Projects
Development

Successfully merging a pull request may close this issue.

2 participants