https://github.com/microbit-foundation/npm-package-versioner-action
Sets the package version from the GitHub actions environment
https://github.com/microbit-foundation/npm-package-versioner-action
Last synced: 12 months ago
JSON representation
Sets the package version from the GitHub actions environment
- Host: GitHub
- URL: https://github.com/microbit-foundation/npm-package-versioner-action
- Owner: microbit-foundation
- License: mit
- Created: 2024-04-16T08:55:51.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-22T13:48:24.000Z (almost 2 years ago)
- Last Synced: 2025-01-20T21:56:40.589Z (over 1 year ago)
- Language: TypeScript
- Size: 1.02 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NPM package versioner GitHub action
[](https://github.com/super-linter/super-linter)
[](https://github.com/actions/typescript-action/actions/workflows/check-dist.yml)
[](https://github.com/actions/typescript-action/actions/workflows/codeql-analysis.yml)
[](./badges/coverage.svg)
Manages the `package.json` version field for GitHub action.
The action will write the new version number to package.json.
Usage:
```yaml
steps:
- uses: microbit-foundation/npm-package-versioner-action@v1
```
## Development
1. :hammer_and_wrench: Install the dependencies
```bash
npm install
```
1. Format, test, and build the action
```bash
npm run all
```
> This step is important! It will run [`ncc`](https://github.com/vercel/ncc)
> to build the final JavaScript action code with all dependencies included.
> If you do not run this step, your action will not work correctly when it is
> used in a workflow. This step also includes the `--license` option for
> `ncc`, which will create a license file for all of the production node
> modules used in your project.
This generates files that must be committed.
## License
This software is under the MIT open source license.
[SPDX-License-Identifier: MIT](LICENSE)
We use dependencies via the npm registry as specified by the package.json file
under common Open Source licenses.
Full details of each package can be found by running `license-checker`:
```bash
npx license-checker --direct --summary --production
```
Omit the flags as desired to obtain more detail.
## Code of Conduct
Trust, partnership, simplicity and passion are our core values we live and
breathe in our daily work life and within our projects. Our open-source projects
are no exception. We have an active community which spans the globe and we
welcome and encourage participation and contributions to our projects by
everyone. We work to foster a positive, open, inclusive and supportive
environment and trust that our community respects the micro:bit code of conduct.
Please see our [code of conduct](https://microbit.org/safeguarding/) which
outlines our expectations for all those that participate in our community and
details on how to report any concerns and what would happen should breaches
occur.