Skip to content

Docs: incorrect version number in the docs + API docs returning 404 #1063

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

Closed
dreamorosi opened this issue Aug 18, 2022 · 1 comment · Fixed by #1066
Closed

Docs: incorrect version number in the docs + API docs returning 404 #1063

dreamorosi opened this issue Aug 18, 2022 · 1 comment · Fixed by #1066
Assignees
Labels
automation This item relates to automation completed This item is complete and has been merged/shipped documentation Improvements or additions to documentation internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.)

Comments

@dreamorosi
Copy link
Contributor

dreamorosi commented Aug 18, 2022

Bug description

As per title of the issue, after releasing the v1.1.1 version, the action that publishes the documentation completed successfully but the version number that corresponds to latest is incorrect (v1.1.0) and the API docs that should be published here, return 404.

Currently investigating, will provide more info once I finish triaging.


[EDIT 1: 7:51PM CEST] After a first assessment I have found why the API docs return a 404. In #1052 I mistakenly removed this step from the workflow which causes the API docs to not be published to latest but only under the version number - i.e. if you browse v1.1.0 they are there.

There is however another issue related to the version issue that I'm still investigating. Even though we just released v1.1.1, the latest version in the docs is v1.1.0. The version number is read from one of the package.json files, and in the last run the version that was read was in fact v1.1.0 (see screenshot below & run here) even though that action ran after the versioning had already happened.

image


[EDIT 2: 3:58PM CEST] I have found the "issue" which is not an issue but a specific behavior of GitHub actions. I have opened a PR and more details are available there, after merging the issue should be resolved.

Expected Behavior

Published docs should reflect latest version & API docs should be available.

Current Behavior

Published docs reflect wrong version & API docs are not available (404).

Possible Solution

N/A

Steps to Reproduce

Check here and/or here.

Environment

  • Powertools version used: N/A
  • Packaging format (Layers, npm): N/A
  • AWS Lambda function runtime: N/A
  • Debugging logs: N/A

Related issues, RFCs

N/A

@dreamorosi dreamorosi added bug Something isn't working triage This item has not been triaged by a maintainer, please wait labels Aug 18, 2022
@dreamorosi dreamorosi self-assigned this Aug 18, 2022
@dreamorosi dreamorosi removed the triage This item has not been triaged by a maintainer, please wait label Aug 18, 2022
@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 the pending-release This item has been merged and will be released soon label Aug 23, 2022
@dreamorosi dreamorosi removed the pending-release This item has been merged and will be released soon label Oct 27, 2022
@dreamorosi dreamorosi changed the title Bug (docs): incorrect version number in the docs + API docs returning 404 Docs: incorrect version number in the docs + API docs returning 404 Nov 14, 2022
@dreamorosi dreamorosi added documentation Improvements or additions to documentation internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) completed This item is complete and has been merged/shipped and removed bug Something isn't working labels Nov 14, 2022
@dreamorosi dreamorosi added the automation This item relates to automation label Nov 14, 2022
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 documentation Improvements or additions to documentation internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.)
Projects
None yet
1 participant