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

Addon docs should use versioned branch when available #2945

Open
jsetton opened this issue Dec 24, 2024 · 3 comments
Open

Addon docs should use versioned branch when available #2945

jsetton opened this issue Dec 24, 2024 · 3 comments
Labels
bug Something isn't working main ui Main UI

Comments

@jsetton
Copy link
Contributor

jsetton commented Dec 24, 2024

The problem

Currently, the addon documentation is being retrieved from either the final (dev) or final-stable (release) branch of the openhab-docs GitHub project. When a new version is released, the final-stable branch is copied into a new versioned branch (e.g. final-4.2.x) while the final is copied into final-stable as the latest release.

This means that older releases are pointing to the final-stable branch and therefore including all the changes to the documentation from all the new releases that came after.

Expected behavior

For release version, the addon documentation should be retrieved from the versioned branch first, if available, based on the runtime version, otherwise fallback to the final-stable branch. This will prevent older releases from showing changes that aren't part of them.

Steps to reproduce

Using OH 4.2, check the Insteon addon description details. The documentation for OH 4.3 release is displayed.

@jsetton jsetton added bug Something isn't working main ui Main UI labels Dec 24, 2024
@jimtng
Copy link
Contributor

jimtng commented Jan 20, 2025

It would be much easier to do this if the docs uses final-4.3.x instead of final-stable.

@jsetton
Copy link
Contributor Author

jsetton commented Jan 20, 2025

Perhaps that's a discussion that should happen in openhab-docs? How would it be backward compatible?

@jimtng
Copy link
Contributor

jimtng commented Jan 20, 2025

How would it be backward compatible?

good question. Older versions will still try to look in final-stable!

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

No branches or pull requests

2 participants