Skip to content

Commit 25c723c

Browse files
author
Matt Mcveigh
committed
Add notes on releasing the package
1 parent aee9e03 commit 25c723c

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

RELEASE.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Releasing a new version of FSharpLint
2+
3+
1. Update the [changelog](CHANGELOG.md) since last release and get the changes onto master.
4+
2. Tag the head of master with the version number in the format `vx.x.x` - for example: `v0.20.2`.
5+
3. Push the tag to remote.
6+
7+
After pushing the tag to remote, the publish pipeline will be kicked off which will:
8+
* Build the package
9+
* Create a github release
10+
* Pushes the package to NuGet
11+
* Publishes the docs to github pages
12+
13+
## Dependencies
14+
15+
* Github secret: `NUGET_KEY`.
16+
* This is the API key from nuget, used to push the package to nuget.
17+
* At the moment the key lives under `duckmatt`'s nuget account, but I believe the `fsprojects` account should also be able to create an applicable API key.
18+
* "Expires in 7 months" from 2021/11/16

0 commit comments

Comments
 (0)