-
Notifications
You must be signed in to change notification settings - Fork 427
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[chore] Add a release-notes script that outputs a release notes template
- Loading branch information
Showing
2 changed files
with
43 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
const CHANGELOG_COMMAND = 'git log --pretty=format:\'%aN | %s | %h\' --abbrev-commit --reverse origin/master..origin/next' | ||
|
||
const execa = require('execa') | ||
const TEMPLATE = ` | ||
Upgrade with: | ||
sanity upgrade | ||
And install the latest Command Line Interface (CLI) with: | ||
npm install --global @sanity/cli | ||
# ✨ Highlights | ||
## Awesome feature X | ||
A few words about the awesome feature X, preferably with screengifs | ||
## Awesome feature Y | ||
A few words about the awesome feature Y, preferably with screengifs | ||
## Other features | ||
- This is feature is not that important, but worth mentioning anyway | ||
# 🐛 Notable bugfixes | ||
- Fixed 🐞 | ||
- Fixed 🐛 | ||
- Fixed 🦗 | ||
# 📓 Full changelog | ||
Author | Message | Commit | ||
------------ | ------------- | ------------- | ||
${execa.shellSync(CHANGELOG_COMMAND).stdout} | ||
` | ||
|
||
console.log(` | ||
-------- SANITY RELEASE NOTES TEMPLATE -------- | ||
Use the following template as a starting point for next release: | ||
A draft can be created here: https://github.com/sanity-io/sanity/releases/new | ||
-------- BEGIN TEMPLATE -------- | ||
${TEMPLATE} | ||
-------- END TEMPLATE --------`) |