Skip to content

Commit 9566727

Browse files
committed
Add docs folder
Split Contributing and Release for better orientation. Add one more item for the release-checklist.
1 parent 0a1af34 commit 9566727

File tree

2 files changed

+16
-10
lines changed

2 files changed

+16
-10
lines changed

Contributing.md renamed to docs/Contributing.md

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -45,13 +45,3 @@ A brief overview of the files,
4545
## Helpful Reading Material
4646

4747
We recommend checking out [Your First VS Code Extension](https://code.visualstudio.com/docs/extensions/example-hello-world) and [Creating a Language Server](https://code.visualstudio.com/docs/extensions/example-language-server) for some introduction to VS Code extensions.
48-
49-
## Release Checklist
50-
51-
- [ ] SemVer Compatible Version Bump in `package.json`
52-
- For pre-releases, we follow the version convention at: https://code.visualstudio.com/api/working-with-extensions/publishing-extension#prerelease-extensions. We use `major.EVEN_NUMBER.patch` for release versions and `major.ODD_NUMBER.patch` for pre-release versions. For example: `2.0.*` for release and `2.1.*` for pre-release.
53-
- [ ] Update ChangeLog.md. The output of `./GenChangelogs.hs` usually suffices.
54-
- [ ] Update the README.md to have no outdated information.
55-
- [ ] Make sure CI is succeeding.
56-
- [ ] If you perform a pre-release, create a [pre-release in Github](https://github.com/haskell/vscode-haskell/releases). The github action will perform the appropriate actions automatically and publish the pre-release of the extension to VSCode- and VSX-Marketplace.
57-
- [ ] If you perform a release, create a [release in Github](https://github.com/haskell/vscode-haskell/releases). The github action will perform the appropriate actions automatically and publish the extension to VSCode- and VSX-Marketplace.

docs/Release.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Release Checklist
2+
3+
Follow this list for items that must be completed for release of the `vscode-haskell` extension.
4+
5+
- [ ] Run `yarn audit` for security vulnerabilities.
6+
- Fix vulnerabilities.
7+
- [ ] Run `yarn outdated` to find outdated package version, review what needs to be updated.
8+
- `yarn upgrade-interactive` and `yarn upgrade-interactive --latest` is helpful here.
9+
- [ ] SemVer Compatible Version Bump in `package.json`
10+
- For pre-releases, we follow the version convention at: https://code.visualstudio.com/api/working-with-extensions/publishing-extension#prerelease-extensions. We use `major.EVEN_NUMBER.patch` for release versions and `major.ODD_NUMBER.patch` for pre-release versions. For example: `2.0.*` for release and `2.1.*` for pre-release.
11+
- [ ] Update ChangeLog.md. The output of `./GenChangelogs.hs` usually suffices.
12+
- [ ] Update the README.md to have no outdated information.
13+
- [ ] Make sure CI is succeeding.
14+
- [ ] Perform the release by creating a [release in Github](https://github.com/haskell/vscode-haskell/releases)
15+
- Github actions will automatically release the extension to VSCode- and VSX-Marketplace.
16+
- If you want to create a pre-release, create a [pre-release in Github](https://github.com/haskell/vscode-haskell/releases). The github action will perform the appropriate actions automatically and publish the pre-release of the extension to VSCode- and VSX-Marketplace.

0 commit comments

Comments
 (0)