Skip to content

Commit 890cb9c

Browse files
authored
docs: add release instructions (#10)
1 parent d9f43de commit 890cb9c

1 file changed

Lines changed: 20 additions & 0 deletions

File tree

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,17 @@ _Proudly built by:_
88

99
<a href="https://technology.condenast.com"><img src="https://user-images.githubusercontent.com/1215971/35070721-3f136cdc-fbac-11e7-81b4-e3aa5cc70a17.png" title="Conde Nast Technology" width=350/></a>
1010

11+
- [Usage](#usage)
12+
13+
- [Configuration](#configuration)
14+
- [Rule Overrides](#rule-overrides)
15+
16+
- [Contributing](#contributing)
17+
- [Develop](#dev)
18+
- [Install](#install)
19+
- [Releasing](#release)
20+
- [FAQ](#faq)
21+
1122
## Usage
1223

1324
This action uses [commitlint](https://github.com/conventional-changelog/commitlint#readme) with the [config-conventional configuration][1] to ensure merge commits meet the conventional commit [spec][0].
@@ -97,6 +108,15 @@ git commit
97108

98109
> Be sure to commit and push all changed files in `./dist` to see your changes to the action execute.
99110

111+
### Release
112+
113+
From the up-to-date `main` branch:
114+
115+
```sh
116+
npm run release
117+
git push --follow-tags
118+
```
119+
100120
## FAQ
101121

102122
**_1. Why is my commit required to conform with the [spec][0]?_**

0 commit comments

Comments
 (0)