An open API service indexing awesome lists of open source software.

https://github.com/twelveiterationmods/bump-version

Bumps either major, minor, or patch of a semantic version. Only works for simple x.y.z versions.
https://github.com/twelveiterationmods/bump-version

github-actions

Last synced: about 2 months ago
JSON representation

Bumps either major, minor, or patch of a semantic version. Only works for simple x.y.z versions.

Awesome Lists containing this project

README

          

## Code in Main

Install the dependencies

```bash
npm install
```

Run the tests :heavy_check_mark:

```bash
$ npm test

PASS ./index.test.js
✓ throws invalid number (3ms)
✓ version 500 ms (504ms)
✓ test runs (95ms)
...
```

## Package for distribution

GitHub Actions will run the entry point from the action.yml. Packaging assembles the code into one file that can be checked in to Git, enabling fast and reliable execution and preventing the need to check in node_modules.

Actions are run from GitHub repos. Packaging the action will create a packaged action in the dist folder.

Run prepare

```bash
npm run prepare
```

Since the packaged index.js is run from the dist folder.

```bash
git add dist
```

## Create a release branch

Users shouldn't consume the action from master since that would be latest code and actions can break compatibility between major versions.

Checkin to the v1 release branch

```bash
git checkout -b v1
git commit -a -m "v1 release"
```

```bash
git push origin v1
```

Note: We recommend using the `--license` option for ncc, which will create a license file for all of the production node modules used in your project.

Your action is now published! :rocket:

## Usage

You can now consume the action by referencing the v1 branch

```yaml
uses: ModdingForBlockheads/bump-semver@v1
with:
version: 1.0.0
bump: minor
```