Skip to content

Commit e36b2ed

Browse files
authored
Update notes about changelog (#83)
1 parent a4252c3 commit e36b2ed

File tree

2 files changed

+8
-17
lines changed

2 files changed

+8
-17
lines changed

CHANGELOG.md

Lines changed: 3 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,10 @@
11
# Changelog
22

3-
This changelog is currently manually maintained. Please see commits, PRs and Issue discussions on GitHub for the latest and most correction information.
3+
As of v8.0.0, changelogs are now automatically generated in the [GitHub Releases page](https://github.com/sgb-io/codehawk-cli/releases).
44

5-
### 8.0.3
5+
The legacy (manual) changelog is preserved below.
66

7-
- Enable publishing from Github Actions for real
8-
- Updated release instructions
9-
10-
### 8.0.1
11-
12-
- Fix release automation
13-
14-
### 8.0.0
15-
16-
- Added new tooling for automating publishing and releasing
17-
- Added contributing docs
18-
- Removed sources from the published build
7+
## Legacy changelog
198

209
### 7.1.5
2110

CONTRIBUTING.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,11 +68,13 @@ Note: currently, only the project owner (sgb-io) has access to publish new versi
6868

6969
The instructions to publish a release are:
7070

71-
- Use macOS, as `np` runs into output + auth problems on windows
71+
- Prefer macOS, as `np` runs into output + auth problems on windows (the auth problems can probably be solved by point at the ssh origin as per below, but the display/interactivity doesn't work as well on windows git bash)
7272
- Important: the git remote must be the ssh url in order for `np` to work correctly. By default, GitHub Desktop uses the https URL as far as I can tell. It can be easily changed via `git remote set-url origin [email protected]:sgb-io/codehawk-cli.git`. If you have failed to do this, the "pushing tags" part will hang. If this happens, ctrl+c out, manually run `git push --follow-tags`.
73-
- Update the changelog and get that merged in (do not bump any versions)
7473
- On an up-to-date master, run Run `yarn run tag:{patch|minor|major}`. This creates a git tag **and pushes it up**.
75-
- The GitHub action should publish to npm
74+
- This also opens a GitHub release draft, publish it.
75+
- The GitHub action should publish to npm automatically. Check the Actions tab to see it happening.
76+
77+
Note: As of v8.0.0, changelogs are now automatically generated by the [GitHub releases page](https://github.com/sgb-io/codehawk-cli/releases).
7678

7779
## Support
7880

0 commit comments

Comments
 (0)