Skip to content

Commit

Permalink
Prepare changelog for new release (#1473)
Browse files Browse the repository at this point in the history
  • Loading branch information
Akuli authored Mar 30, 2024
1 parent b5089ac commit 1fbfa09
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 23 deletions.
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,15 @@ Unlike the Git commit history, this changelog does not include code cleanups
and other details that don't affect using Porcupine.


## Unreleased

- There are two new easter eggs in the about dialog. Happy Easter :)
- Porcupine's documentation has been updated and rearranged. The documentation is now clearly split into two folders, [user-doc](https://github.com/Akuli/porcupine/tree/main/user-doc) for using Porcupine and [dev-doc](https://github.com/Akuli/porcupine/tree/main/dev-doc) for developing Porcupine. Both folders also contain newly written documentation. Porcupine Wiki was deleted, and deleting `akuli.github.io/porcupine` is planned.
- The contents of the *Help* menu at top were updated. For example, *User Documentation* opens the `user-doc` folder.
- Porcupine now checks for updates when it starts. Many other programs do this in an annoying way (with e.g. a popup message). Porcupine notifies you about a new version by showing a message in the status bar instead. If this is still too annoying, you can easily disable update checking in *Porcupine Settings* or in the plugin manager.
- All right-click menus are now offset a little bit from the cursor location, so that you don't accidentally click the first item in the right-click menu. Thank you [ethical-haquer](https://github.com/ethical-haquer) for fixing this.


## v2024.03.09

Bug fixes:
Expand Down
23 changes: 0 additions & 23 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,26 +79,3 @@ Compared to GitHub issues, IRC feels more like a casual conversation,
and we often discuss things that have nothing to do with Porcupine.
To join ##learnpython, you can e.g. go to https://kiwiirc.com/nextclient/irc.libera.chat/##learnpython
or run [Akuli's mantaray program](https://github.com/Akuli/mantaray).


## Releasing Porcupine

These instructions are meant for Porcupine maintainers.
Other people shouldn't need them.

1. Update `CHANGELOG.md` based on Git logs (e.g. `git log --all --oneline --graph`).
You should add a new section to the beginning with `Unreleased` instead of a version number.
Don't split the text to multiple lines any more than is necessary,
as that won't show up correctly on GitHub's releases page.
2. Make a pull request of your changelog edits. Review carefully:
changing the changelog afterwards is difficult, as the text gets copied into the releases page.
3. Merge the pull request and pull the merge commit to your local `main` branch.
4. Run `python3 scripts/release.py` from the `main` branch.
The script pushes a tag named e.g. `v2022.08.28`,
which triggers the parts of `.github/workflows/release-builds.yml`
that have `if: startsWith(github.ref, 'refs/tags/v')` in them.
They build and deploy docs, copy the changelog to the releases page, and so on.

If you want, you can also do a release from a branch named `bugfix-release` instead of `main`.
This is useful if you fixed a bug that made Porcupine unusable for someone,
but the new features on `main` aren't ready for releasing yet.
21 changes: 21 additions & 0 deletions dev-doc/releasing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Releasing Porcupine

These instructions are meant for Porcupine maintainers.
Other people shouldn't need them.

1. Update `CHANGELOG.md` based on Git logs (e.g. `git log --all --oneline --graph`).
You should add a new section to the beginning with `Unreleased` instead of a version number.
Don't split the text to multiple lines any more than is necessary,
as that won't show up correctly on GitHub's releases page.
2. Make a pull request of your changelog edits. Review carefully:
changing the changelog afterwards is difficult, as the text gets copied into the releases page.
3. Merge the pull request and pull the merge commit to your local `main` branch.
4. Run `python3 scripts/release.py` from the `main` branch.
The script pushes a tag named e.g. `v2022.08.28`,
which triggers the parts of `.github/workflows/release-builds.yml`
that have `if: startsWith(github.ref, 'refs/tags/v')` in them.
They build and deploy docs, copy the changelog to the releases page, and so on.

If you want, you can also do a release from a branch named `bugfix-release` instead of `main`.
This is useful if you fixed a bug that made Porcupine unusable for someone,
but the new features on `main` aren't ready for releasing yet.

0 comments on commit 1fbfa09

Please sign in to comment.