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

scikit-image stable release notes point to file on main branch #5380

Open
jni opened this issue May 6, 2021 · 6 comments
Open

scikit-image stable release notes point to file on main branch #5380

jni opened this issue May 6, 2021 · 6 comments
Labels
🤖 type: Infrastructure CI, packaging, tools and automation

Comments

@jni
Copy link
Member

jni commented May 6, 2021

Description

If you go to scikit-image.org and click on release notes, it points to the latest release notes — on the master branch. It should instead point to the release notes on the tagged release.

@alexdesiqueira
Copy link
Member

@jni right now, it links to https://github.com/scikit-image/scikit-image/blob/main/doc/release/release_0.18.rst for me. What would we expect there?

@alexdesiqueira
Copy link
Member

@mkcor
Copy link
Member

mkcor commented Jul 15, 2021

@jni right now, it links to https://github.com/scikit-image/scikit-image/blob/main/doc/release/release_0.18.rst for me.

@alexdesiqueira same here, and it doesn't seem odd to me. But I agree that

Maybe point to https://github.com/scikit-image/scikit-image/releases/latest?

looks nicer.

In the website repo, we should update master to main, in order to avoid the "Branch master was renamed to main" banner.

I don't get it because...
https://github.com/scikit-image/scikit-image-web/blob/0e2767e71509f1126d265da80f12fb14c25ba63b/_templates/sidebar_versions.html#L37
URL "https://github.com/scikit-image/scikit-image/tree/master/doc/release" doesn't include an actual file (release_0.18.rst).

@mkcor
Copy link
Member

mkcor commented Jul 15, 2021

There's another link to 'release notes here' leading to https://scikit-image.org/docs/stable/release_notes.html

link_release_notes_here

and it's consistent in the case of older versions (https://scikit-image.org/docs/<older version in 0.minor.x format>/release_notes_and_installation.html) but it's a little less intuitive for the dev version (https://scikit-image.org/docs/dev/release_notes.html):

dev_release_notes

@mkcor
Copy link
Member

mkcor commented Jul 15, 2021

@jni
Copy link
Member Author

jni commented Jul 16, 2021

I don't have strong ideas here. My main motivation for this was that releases happened on branches, so the main branch notes could be out of date with the release branch. Now that we are making releases just with tags + CI (no branching), that is less of a concern. Although #5475 might change that temporarily yet again. 😅 I think though that ideally, yes, we should render release notes in the docs and use that, as napari does.

@rfezzani rfezzani added the 🤖 type: Infrastructure CI, packaging, tools and automation label Oct 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🤖 type: Infrastructure CI, packaging, tools and automation
Projects
None yet
Development

No branches or pull requests

4 participants