Skip to content

Remove version field from package.json #39

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

Merged
merged 1 commit into from
May 10, 2023

Conversation

MatteoPologruto
Copy link
Contributor

The version field is only needed if the package is to be published. In this project, package.json is used only for management of the dependencies and scripts for internal development.

For this reason, having a version field in the file is harmful because it increases the effort and complexity of making a release, and also is likely to get out of sync with the true version.

Reference:

https://docs.npmjs.com/cli/v8/configuring-npm/package-json#version

If you don't plan to publish your package, the name and version fields are optional.


This was done last year for the arduino/setup-task action without any ill effects: arduino/setup-task#49.
The same was done for the arduino/arduino-lint-action action: arduino/arduino-lint-action#69

@MatteoPologruto MatteoPologruto added type: enhancement Proposed improvement topic: infrastructure Related to project infrastructure labels May 10, 2023
@MatteoPologruto MatteoPologruto self-assigned this May 10, 2023
@MatteoPologruto MatteoPologruto merged commit 71b5e9c into arduino:main May 10, 2023
@MatteoPologruto MatteoPologruto deleted the remove-version-field branch May 10, 2023 11:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: infrastructure Related to project infrastructure type: enhancement Proposed improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants