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

Release documentation folder names do not strip tag prefix #52

Open
JonatanAntoni opened this issue Dec 19, 2023 · 1 comment
Open

Release documentation folder names do not strip tag prefix #52

JonatanAntoni opened this issue Dec 19, 2023 · 1 comment
Assignees
Labels
bug Something isn't working

Comments

@JonatanAntoni
Copy link
Contributor

JonatanAntoni commented Dec 19, 2023

Issue description

Given release tags are using "complex" prefix (e.g., pack/v<VERSION>), like in CMSIS-View.

On release, the documentation is pushed onto the gh-pages branch into a folder named like the tag. For plain tags (without / in the name) this results in a new top-level folder as expected. But for "complex" tag names (with / in the name) this creates a folder hierarchy.

For CMSIS-View for example, having the release tags pack/v1.0.0 and pack/v1.1.0 lead to the folder structure on gh-pages branch like this:

 📦
 ┣ 📂 pack 
 ┃ ┣ 📂 v1.0.0                 release 1.0.0 documentation
 ┃ ┗ 📂 v1.1.0                 release 1.1.0 documentation
 ┣ 📂 main                     main branch documentation
 ┣ 📂 latest -> pack/v1.1.0    link to latest release documentation
 ┗ 📋 versions.js              Version selector

Unfortunately, when updating the versions.js file, searching for documentation versions is limited to the first directory level. This leads to documentation version published into some subfolder hierarchy not to be listed.

Expected behaviour

Instead, on the gh-pages branch all release versions should show up as s top-level folder named according to the release version. The release version is considered to be the tag name without the prefix.

For above example, the expected folder structure is like this:

 📦
 ┣ 📂 1.0.0                  release 1.0.0 documentation
 ┣ 📂 1.1.0                  release 1.1.0 documentation
 ┣ 📂 main                   main branch documentation
 ┣ 📂 latest -> 1.1.0        link to latest release documentation
 ┗ 📋 versions.js            Version selector
@JonatanAntoni JonatanAntoni self-assigned this Dec 19, 2023
@JonatanAntoni JonatanAntoni added the bug Something isn't working label Dec 19, 2023
@JonatanAntoni
Copy link
Contributor Author

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant