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

Working draft version of the website? #868

Open
JohnTitor opened this issue Aug 13, 2022 · 2 comments
Open

Working draft version of the website? #868

JohnTitor opened this issue Aug 13, 2022 · 2 comments

Comments

@JohnTitor
Copy link
Member

JohnTitor commented Aug 13, 2022

Currently, every change here is published every day by GHA workflow: https://github.com/semver/semver.org/blob/gh-pages/.github/workflows/sync.yml

But it means every change needs to bump up the semver's version (NB: we currently don't though), even a change fixes just a small typo, otherwise, it makes a difference between the tagged version and the published version on the website. And it'd also be confusing to have specifications published under the same version but showing different content from day to day (related: #799).

Maybe it's better to have a working draft version of the website (e.g. draft.semver.org) and do versioning precisely?

(This issue talks about the website, but it's also related to the semver's versioning, so I'm going to open it here.)

/cc #604, #783

@steveklabnik
Copy link
Member

Some sort of "latest" version seems prudent, yeah.

@jwdonahue
Copy link
Contributor

Perennial complaint. The published spec does not adhere to SemVer versioning. I think the working draft was reflected in the readme.md file for a long time, while the official site content was being generated in the other repo, and that caused some consternation due to them both having the same version number and different content.

The version should not be bumped simply because some automation republishes the content, but it should get bumped for all content changes. Adding new translations, FAQ's, etc., should always be a minor bump. Changes to the spec that make it more clear, with modifying the versioning semantics should be patch level bumps.

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

No branches or pull requests

4 participants
@steveklabnik @jwdonahue @JohnTitor and others