Skip to content
This repository has been archived by the owner on Aug 1, 2020. It is now read-only.

Commit

Permalink
ci: create changelog manually (closes #4)
Browse files Browse the repository at this point in the history
  • Loading branch information
bates64 committed Feb 9, 2020
1 parent c37b575 commit 29fd66b
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 58 deletions.
23 changes: 0 additions & 23 deletions .github/chglog/CHANGELOG.tpl.md

This file was deleted.

27 changes: 0 additions & 27 deletions .github/chglog/config.yml

This file was deleted.

9 changes: 3 additions & 6 deletions .github/workflows/push.yml
Original file line number Diff line number Diff line change
Expand Up @@ -191,11 +191,8 @@ jobs:
run: for file in starpkg-*; do openssl dgst -sha256 -r "$file" | awk '{print $1}' > "${file}.sha256"; done

- name: Generate release notes
run: |
# Temporary fix for https://github.com/actions/setup-go/issues/14
export PATH=$PATH:$(go env GOPATH)/bin
go get -u github.com/git-chglog/git-chglog/cmd/git-chglog
git-chglog -c .github/chglog/config.yml $(git describe --tags) > RELEASE.md
run: awk 'NR!=1 && /^## /{exit} {print}' CHANGELOG.md > RELEASE.md

- name: Create GitHub release ${{ matrix.target }}
uses: softprops/action-gh-release@v1
with:
Expand All @@ -210,4 +207,4 @@ jobs:
starpkg-x86_64-pc-windows-msvc.zip.sha256
body_path: RELEASE.md
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
- Added _private exports_! Any export name beginning with `_` will be considered private to the
package which owns it. Packages may not directly reference the private exports of their
dependencies.
- Fixed crash when loading packages from any parent directory `--dir ..` (3d3f804)
- Fixed `starpkg new` failing when used in a subdirectory of any existing package (#2, ff5c306)
- Customized the user guide theme (867432a, 0fd9197)
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,7 @@ next major release of starpkg.

For commit scopes, prefer using the name of a starpkg subcommand, eg. `new`, if relevant.

Changelogs are generated with [git-chglog](https://github.com/git-chglog/git-chglog) upon release.
Only some commit types (`feat`, `fix`, `pref`, `improve`) will be shown in release changelogs.
**If you make a user-facing change, make sure to add it to the changelog!**

## Linting

Expand All @@ -37,6 +36,7 @@ $ cargo mdbook serve
## Releases

- Bump [Cargo.toml](Cargo.toml) version according to [semver](https://semver.org/spec/v2.0.0.html)
- Prepend `## [VERSION]` to `CHANGELOG.md`
- `git add -A && git commit -m "chore(release): [VERSION]"`
- `git tag v[VERSION]`
- `git push && git push --tags`

0 comments on commit 29fd66b

Please sign in to comment.