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

Unify endpoint for accessing Jenkins release notes across weekly and LTS releases #7819

Closed
janfaracik opened this issue Jan 18, 2025 · 15 comments · Fixed by #7838 or jenkinsci/design-library-plugin#391

Comments

@janfaracik
Copy link
Contributor

Suggestion

Currently, the Jenkins release notes are accessible via separate URLs depending on whether the version is from the LTS or weekly release streams:
• LTS Versions: Accessed via URLs such as https://www.jenkins.io/changelog-stable/{version} (e.g., https://www.jenkins.io/changelog-stable/2.479.3/).
• Weekly Versions: Accessed via URLs such as https://www.jenkins.io/changelog/{version} (e.g., https://www.jenkins.io/changelog/2.493/).

This separation requires users to know whether a specific version belongs to the LTS or weekly stream, which can be inconvenient and non-intuitive. A unified endpoint (e.g., /changelog/{version}) that accepts any valid Jenkins version, regardless of its type, would improve usability.

For example:
https://www.jenkins.io/changelog/2.479.3/ (LTS) should work the same way as https://www.jenkins.io/changelog-stable/2.479.3/.
https://www.jenkins.io/changelog/2.493/ (weekly) should remain functional as it is now.

We're currently linking to LTS releases in Design Library and we'd like to expand that to include weeklys too - a unified endpoint would make it much easier for us rather than having to handle that logic on our side.

Links

No response

Are you interested in contributing to this improvement?

If I have the time I'd be happy to, but also happy to point new contributors in the right direction for this.

@saurabhraghuvanshii
Copy link
Contributor

@janfaracik I want to work on this but I need help for this at some point.

@biru-codeastromer
Copy link
Contributor

Hello @janfaracik Sir, I see the issue is opened still and also there is no linked PR to it. Let me know if I can work in it.Thanks!

@biru-codeastromer
Copy link
Contributor

@saurabhraghuvanshii Let me know if you are working on it, or I can raise a PR for it!

@saurabhraghuvanshii
Copy link
Contributor

saurabhraghuvanshii commented Jan 27, 2025

@biru-codeastromer I work on it , thanks , i wait for conformation from maintainers therefore I wait , going to raise Pr in two days.

@biru-codeastromer
Copy link
Contributor

@biru-codeastromer I work on it , thanks , i wait for conformation from maintainers therefore I wait , going to raise Pr in two days.

Sure ! All the best moving ahead in your PR .

@saurabhraghuvanshii
Copy link
Contributor

@janfaracik sir , I found difficulty on finding files where I have to changes , Is there is another repo for links where I can changes and make one common links.

@janfaracik
Copy link
Contributor Author

janfaracik commented Jan 28, 2025

Hey folks 👋

This is the right repo for such a change - I've made a start in this branch https://github.com/jenkins-infra/jenkins.io/compare/master...janfaracik:jenkins.io:one-changelog?expand=1 - feel free to pick up from there if there's anything you feel needs doing, would be good to validate its all working.

The gist is is we need to generate new changelog/{version} pages for LTS releases, thankfully due to how this project is structured it's fairly simple, just adding a new line extension ChangelogReleases.new(:lts, 'changelog', 'stable') in content/_ext/pipeline.rb.

I've left the existing changelog-stable/{version} pages in just in case there are other pages linking to them (I know Jenkins Design Library does for example).

I had one small issue with the back links, they needed to be updated so that they point correctly to either the stable changelog or the weekly changelog, as far as I know this isn't possible in HAML so I've moved that code to content/_ext/changelog_releases.rb. It's working as expected now.

All the best,

Jan

@saurabhraghuvanshii
Copy link
Contributor

@janfaracik sir, as your commit works in local it render filehttp://localhost:4242/changelog/2.479.3/ as i go back url is http://localhost:4242/changelog-stable/ ,

@janfaracik
Copy link
Contributor Author

@janfaracik sir, as your commit works in local it render filehttp://localhost:4242/changelog/2.479.3/ as i go back url is http://localhost:4242/changelog-stable/ ,

That's expected - would you be able to open a pull request?

@saurabhraghuvanshii
Copy link
Contributor

I can but it's your commit and your hard work how I can

@janfaracik
Copy link
Contributor Author

I can but it's your commit and your hard work how I can

Appreciate you testing this and confirming it works locally :)

Honestly, it’s totally fine for you to open the pull request - if you’re happy to raise the PR, go for it. But if you’d rather I do it, just let me know and I'll get it up.

Cheers,

Jan

@saurabhraghuvanshii
Copy link
Contributor

Then I will raise Pr , thanks sir for support

@janfaracik
Copy link
Contributor Author

Then I will raise Pr , thanks sir for support

Thanks!

Would you be able to make a pull request to update https://github.com/jenkinsci/design-library-plugin/blob/87d9d5804bc14492d5ae5ed6c5d813ae6624ff0b/src/main/resources/lib/samples/layout.jelly#L51 as well? It just needs to drop the -stable part of the URL.

@saurabhraghuvanshii
Copy link
Contributor

yes I can.

@saurabhraghuvanshii
Copy link
Contributor

done sir

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants