Skip to content

Commit fdbb856

Browse files
authored
Update README.md
1 parent 81e5a72 commit fdbb856

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,19 @@
11
# action-version-release
2-
GitHub Action to write VERSION.txt and include it in each release.
2+
Simple GitHub Action to write VERSION.txt and include it in each release. Note this force updates the release tag, such that the tagged commit contains the new VERSION.txt file.
3+
4+
## Usage
5+
```yaml
6+
name: Release
7+
8+
on:
9+
release:
10+
types: [published]
11+
branches: [main]
12+
13+
jobs:
14+
version:
15+
runs-on: ubuntu-latest
16+
steps:
17+
- uses: actions/checkout@v2
18+
- uses: BattlesnakeOfficial/action-version-txt@v1
19+
```

0 commit comments

Comments
 (0)