Skip to content

Commit cd517ea

Browse files
committed
[CI] document release workflow
1 parent 2ed535c commit cd517ea

File tree

2 files changed

+8
-3
lines changed

2 files changed

+8
-3
lines changed

.github/workflows/release.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ on:
44
push:
55
branches:
66
- master
7-
- release-**
87
pull_request:
98
branches:
10-
- '**'
9+
- master
1110
release:
12-
types: [published]
11+
types:
12+
- published
1313

1414
jobs:
1515

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,8 @@ Code style is enforced with pre-commit. To use :
1414
pip install pre-commit
1515
pre-commit install
1616
```
17+
18+
releases
19+
--------
20+
21+
To make realeses, create a github release with tag name of format `vX.Y.Z` (optionally `vX.Y.Z-R`)

0 commit comments

Comments
 (0)