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.

Sign up for GitHub

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

Jump to bottom

feat: add a built-in changelog page (updated) #49

Merged
merged 11 commits into from
Jan 6, 2025
Merged

feat: add a built-in changelog page (updated) #49

merged 11 commits into from
Jan 6, 2025

Conversation

UltimatChamp
Copy link
Contributor

@UltimatChamp UltimatChamp commented Jul 16, 2024 •
edited
Loading

Closes #43.
Closes #50.

Changes:

Light Mode

Screenshot 2024-12-13 122736

Dark Mode

Screenshot 2024-12-13 122812

hover.mp4

  • The changelog can also be accessed via: http://neoforged.net/changelog

  • The changelog can also be found here:

  • The changelog link in the Installer Files section has also been replaced.

  • Added the ability to install a specific version from the changelog.

  • Fix compatibility with the latest version of Hugo.

Old
  • A latest and a legacy(1.20.1) changelog pages.


Preview URL: https://pr-49.neoforged-website-previews.pages.dev

@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-website-previews (Preview) July 16, 2024 07:47 Active
@neoforged-pages-deployments
Copy link

neoforged-pages-deployments bot commented Jul 16, 2024 •
edited
Loading

Deploying with Cloudflare Pages

Name Result
Last commit: 6057b70915ca69501570afe17fa09d00923e03b0
Status: ✅ Deploy successful!
Preview URL: https://a5fd3f9d.neoforged-website-previews.pages.dev
PR Preview URL: https://pr-49.neoforged-website-previews.pages.dev

@UltimatChamp
Copy link
Contributor Author

UltimatChamp commented Jul 16, 2024 •
edited
Loading

Hmm...
1.20.1 throws this error:
image
image

nvm it seems to work well now:
image

@neoforged-automation neoforged-automation bot added the needs rebase This Pull Request needs to be rebased before being merged label Aug 24, 2024
@neoforged-automation
Copy link

@UltimatChamp, this pull request has conflicts, please resolve them for this PR to move forward.

@neoforged-automation neoforged-automation bot removed the needs rebase This Pull Request needs to be rebased before being merged label Dec 12, 2024
@UltimatChamp UltimatChamp marked this pull request as draft December 12, 2024 07:27
@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-website-previews (Preview) December 12, 2024 07:27 Active
@UltimatChamp
Copy link
Contributor Author

Marking this as draft, as I have some plans instead of just a code-block.

@UltimatChamp
Copy link
Contributor Author

UltimatChamp commented Dec 12, 2024 •
edited
Loading

Current progress (local):

image

This currently lacks css and stuff. Btw, open to your suggestions.

@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-website-previews (Preview) December 12, 2024 10:00 Active
@UltimatChamp
Copy link
Contributor Author

UltimatChamp commented Dec 12, 2024 •
edited
Loading

image

more progress

@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-website-previews (Preview) December 12, 2024 10:28 Active
@UltimatChamp
feat: more features to the changelog
8c90369 
* fix the changelog in light mode
* ability to install a specific version from the changelog
* make changelog version descriptions more differentiable
* support for issue links and code blocks in the changelog
* also fix compat with the latest Hugo
@UltimatChamp UltimatChamp marked this pull request as ready for review December 13, 2024 07:11
@UltimatChamp
Copy link
Contributor Author

UltimatChamp commented Dec 13, 2024 •
edited
Loading

More Changes

  • Fix the changelog in light mode.
  • Add the ability to install a specific version from the changelog.
  • Make changelog version descriptions more distinguishable.
  • Add support for issue links and code blocks in the changelog.
  • Fix compatibility with the latest version of Hugo.

@UltimatChamp UltimatChamp changed the title feat: static links for changelogs feat: add a built-in changelog page Dec 13, 2024
@UltimatChamp UltimatChamp changed the title feat: add a built-in changelog page feat: add a built-in changelog page (updated) Dec 13, 2024
@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-website-previews (Preview) December 13, 2024 08:05 Active
@Technici4n
Copy link
Member

Looks amazing!

  • The links for each version download all point to the latest version.
  • The changelogs category is a bit weird, there should be a way to move the page outside of any category?

@sciwhiz12 sciwhiz12 added the enhancement New feature or request label Jan 2, 2025
@shartte
Copy link
Contributor

shartte commented Jan 2, 2025

We can do this, but I was actually thinking about outputting a JSON changelog too to also link to each commit.
This code is string-parsing the text based changelog, which isn't ideal.

@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-website-previews (Preview) January 3, 2025 06:58 Active
@UltimatChamp
Copy link
Contributor Author

  • The links for each version download all point to the latest version.

Whoops! Fixed now.

  • The changelogs category is a bit weird, there should be a way to move the page outside of any category?

Yeah, this PR was made way back, when a legacy version (1.20.1) of Neoforge existed.
I've now removed the category, and the changelog can now be accessed here: http://neoforged.net/changelog

@UltimatChamp
Copy link
Contributor Author

We can do this, but I was actually thinking about outputting a JSON changelog too to also link to each commit. This code is string-parsing the text based changelog, which isn't ideal.

That would be very convenient. The current code uses some quirks to figure things out, like - for new lines and for their descriptions.

Technici4n
Technici4n requested changes Jan 4, 2025
View reviewed changes
Copy link
Member

@Technici4n Technici4n left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm happy to accept this PR as-is, we can easily iterate on it later. Two questions though.

themes/mainroad/layouts/partials/comments.html
{{ if and .Site.DisqusShortname (index .Params "comments" | default "true") (not .Site.IsServer) }}
{{ if and .Site.Config.Services.Disqus.Shortname (index .Params "comments" | default "true") (not hugo.IsServer) }}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why these changes?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To prevent crashing with the latest Hugo.

layouts/shortcodes/changelog.html Outdated
@@ -0,0 +1,17 @@
{{ if not ( .Page.Scratch.Get "nfJS") }}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you sure about this scratch stuff? At least call it changelogJS.

Copy link
Contributor Author

@UltimatChamp UltimatChamp Jan 6, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On doing some research, this line is required to ensure that the js file is included only once on a page...? So I guess you're right.

Technici4n
Technici4n reviewed Jan 4, 2025
View reviewed changes
assets/js/changelog.js Outdated Show resolved Hide resolved
@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-website-previews (Preview) January 6, 2025 06:25 Active
@Technici4n
Copy link
Member

Thanks a lot, this is nice! Let's iterate from here.

@Technici4n Technici4n merged commit c765cee into neoforged:main Jan 6, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Technici4n Technici4n Technici4n requested changes

Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Link to projects.neoforged.net Static Links for Easy access
4 participants
@UltimatChamp @Technici4n @shartte @sciwhiz12