Skip to content

microbit-foundation/npm-package-versioner-action

Repository files navigation

NPM package versioner GitHub action

GitHub Super-Linter CI Check dist/ CodeQL Coverage

Manages the package.json version field for GitHub action.

The action will write the new version number to package.json.

Usage:

steps:
  - uses: microbit-foundation/npm-package-versioner-action@v1

Development

  1. 🛠️ Install the dependencies

    npm install
  2. Format, test, and build the action

    npm run all

    This step is important! It will run 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

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:

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 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.