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

Display the current recommended release for some versions on the website. #12

Open
eerussianguy opened this issue Oct 10, 2022 · 1 comment
Labels
enhancement New feature or request

Comments

@eerussianguy
Copy link

So I often find myself wanting to update my parchment install or add it to a project, but it's a little bit hard if you're not in discord to find what version to use. Some sort of string that can update regularly (or even show up on this repo) would make things a little faster. I've always liked how PYPI projects generate a little install string to display on the website in large letters, so you always have the thing you need first before anything else. If it could say something like mappings channel="parchment", version="xyz" that would be wonderful.

image

@sciwhiz12 sciwhiz12 transferred this issue from ParchmentMC/Parchment Nov 5, 2022
@sciwhiz12 sciwhiz12 added the enhancement New feature or request label Nov 5, 2022
@sciwhiz12
Copy link
Member

This is related to #6 and ParchmentMC/Parchment#113. While I did look into trying this in #11, I found that a self-updating version string snippet on the site is currently not possible.

I first considered the idea of a JSON file at the website root which contains a map of MC versions to latest Parchment releases, which was suggested in part by ParchmentMC/Parchment#63. However, to my understanding, because the site is built as a Docker container, it is difficult to include such a JSON file for serving on the site. That doesn't also include having to figure out which part of the toolchain would be responsible for updating said JSON file.

In the linked issue above, it was suggested as a resolution to read the maven-metadata.xml file. However, this suffers from two problems: one cannot determine the MC versions which we provide mappings for (because it is part of the artifact name), and CORS blocks page JS from loading the maven metadata file from the maven (which redirects to JFrog, which we do not control). We will be investigating this a bit more in the coming months if we can find a resolution, but until then, this is not an option.

I'll keep this issue up for now because I do like the idea. Maybe in the future we'll find a suitable solution.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants