Skip to content

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

@dreamorosi

Description

@dreamorosi

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

Metadata

Metadata

Assignees

Labels

automationThis item relates to automationcompletedThis item is complete and has been merged/shippeddocumentationImprovements or additions to documentationinternalPRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.)

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions