Skip to content
This repository was archived by the owner on Jul 16, 2023. It is now read-only.

Commit eff055a

Browse files
committed
docs: add release guide
1 parent 98c879d commit eff055a

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

RELEASE_GUIDE.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Release guide
2+
3+
## Changelog updates
4+
5+
* each entry should end with a `.`
6+
* all updated entities has a link pointing to the website (ex. rule update, metric update)
7+
8+
## Check and bump version
9+
10+
* the version should be updated in:
11+
* ./CHANGELOG.md
12+
* ./CONTRIBUTING.md
13+
* ./pubspec.yaml
14+
* ./README.md
15+
* ./lib/src/version.dart
16+
* ./tools/analyzer_plugin/pubspec.yaml
17+
* ./website/docs/getting-started/installation.md
18+
19+
## Publishing
20+
21+
* commit and push all changes to the master branch
22+
* create a git tag with a new version name
23+
* run `dart pub publish --dry-run.`. Only one warning is allowed:
24+
25+
```bash
26+
Rename the top-level "tools" directory to "tool".
27+
The Pub layout convention is to use singular directory names.
28+
Plural names won't be correctly identified by Pub and other tools.
29+
See https://dart.dev/tools/pub/package-layout.
30+
```
31+
32+
* run `dart pub publish`
33+
* create a [new draft release on pub](https://github.com/dart-code-checker/dart-code-metrics/releases)
34+
* select the newly created tag
35+
* generate release notes (clean them from the dependabot updates)
36+
* publish release

0 commit comments

Comments
 (0)