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

chore: remove version number from package.json for each library #23

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

jemc
Copy link
Collaborator

@jemc jemc commented May 10, 2024

We are using semantic-release which overrides the number in package.json with an appropriate version number and doesn't commit it back to git. To understand the reasons why it doesn't, please see this FAQ entry: https://github.com/semantic-release/semantic-release/blob/73bcd0bcdb98322c5c5224ffb55960de114c3fd1/docs/support/FAQ.md#why-is-the-packagejsons-version-not-updated-in-my-repository

But having the version numbers in our repository is potentially confusing because people may look to that field to see what the latest version is.

So this commit updates our repo to use the value 0.0.0-semantically-released, as per the recommendation of that same FAQ entry, so as to use a less confusing value that points to the right way to see our latest version, while still technically adhering to the requirements of the package.json format about a version number being present and using a valid version format.

@jemc jemc requested review from andreszorro and InfraK May 10, 2024 19:23
@jemc jemc self-assigned this May 10, 2024
@jemc jemc marked this pull request as draft May 10, 2024 19:27
@jemc jemc removed request for andreszorro and InfraK May 10, 2024 19:27
@jemc
Copy link
Collaborator Author

jemc commented May 10, 2024

Hmm... "it works on my machine".

I'll give this a closer look soon.

@jemc jemc force-pushed the chore/remove-package-json-version branch from 4471564 to e514428 Compare May 10, 2024 19:31
We are using `semantic-release` which overrides the number in `package.json`
with an appropriate version number and doesn't commit it back to git.
To understand the reasons why it doesn't, please see this FAQ entry:
https://github.com/semantic-release/semantic-release/blob/73bcd0bcdb98322c5c5224ffb55960de114c3fd1/docs/support/FAQ.md#why-is-the-packagejsons-version-not-updated-in-my-repository

But having the `version` numbers in our repository is potentially confusing
because people may look to that field to see what the latest version is.

So this commit updates our repo to use the value `1.0.0-semantically-released`,
as per the recommendation of that same FAQ entry (but using `1` as the major
version so as not to break `pnpm` tooling), so we can use a less confusing
value that points to the right way to see our latest version, while still
technically adhering to the requirements of the `package.json` format
about a version number being present and using a valid version format.
@jemc jemc force-pushed the chore/remove-package-json-version branch from e514428 to d7082fd Compare May 10, 2024 19:51
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

Successfully merging this pull request may close these issues.

1 participant