Skip to content

Commit 8e18eb0

Browse files
feat: build for release
1 parent a1aedd7 commit 8e18eb0

3 files changed

Lines changed: 6020 additions & 2188 deletions

File tree

README.md

Lines changed: 78 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,79 @@
1-
This Source contains the source code and configurations for the Dolittle EstablishContext Github action.
1+
# GitHub Action - Increment Version
2+
This GitHub action increments a given version.
23

3-
## Pre requisites
4-
* Node >= 12
5-
* npm
6-
* yarn
4+
![Github JavaScript Actions CI/CD](https://github.com/dolittle/increment-version-action/workflows/Github%20JavaScript%20Actions%20CI/CD/badge.svg)
5+
6+
### Pre requisites
7+
Create a workflow `.yml` file in your `.github/workflows` directory. An [example workflow](#example-workflow) is available below.
8+
9+
For more information, reference the GitHub Help Documentation for [Creating a workflow file](https://help.github.com/en/articles/configuring-a-workflow#creating-a-workflow-file)
10+
11+
### Inputs
12+
- `version` (required): The version to increment
13+
- `release-type` (required): The release type to increment the version with
14+
- `prerelease-identifier`: The prerelease identifier to use when incrementing
15+
16+
### Outputs
17+
- `previous-version`: The inputted version
18+
- `next-version`: The incremented version
19+
20+
### Example Workflow
21+
```yaml
22+
on:
23+
push:
24+
branches:
25+
- '**'
26+
pull_request:
27+
types: [closed]
28+
29+
name: Increment Version
30+
31+
jobs:
32+
context:
33+
name: Increment Version
34+
runs-on: ubuntu-latest
35+
steps:
36+
- name: Checkout code
37+
uses: actions/checkout@v2
38+
- name: Increment version
39+
uses: dolittle/increment-version-action@v2
40+
with:
41+
version: 2.0.0
42+
release-type: minor
43+
44+
```
45+
46+
### Example Workflow - Increment to new minor prerelease
47+
```yaml
48+
on:
49+
push:
50+
branches:
51+
- '**'
52+
pull_request:
53+
types: [closed]
54+
55+
name: Increment Version
56+
57+
jobs:
58+
context:
59+
name: Increment Version
60+
runs-on: ubuntu-latest
61+
steps:
62+
- name: Checkout code
63+
uses: actions/checkout@v2
64+
- name: Increment version
65+
uses: dolittle/increment-version-action@v2
66+
with:
67+
version: 2.0.0
68+
release-type: preminor
69+
prerelease-identifier: alpha
70+
71+
```
72+
73+
## Contributing
74+
We're always open for contributions and bug fixes!
75+
76+
### Pre requisites
77+
- node <= 12
78+
- yarn
79+
- git

action.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,5 +18,5 @@ outputs:
1818
description: The incremented version
1919

2020
runs:
21-
using: 'node12'
21+
using: 'node16'
2222
main: 'release/index.js'

0 commit comments

Comments
 (0)