A local-first personal finance app
Add docs for auto-generated release notes (#129)
Jed Fox13ecf64ddbf2
diff --git a/README.md b/README.mdindex bdc63ec251..200ff657e8 100644--- a/README.md+++ b/README.md@@ -14,12 +14,12 @@ Actual Budget can be installed on many different platforms, however at this time- Local Installation (on your own machine)- Fly.io-- PikaPods+- PikaPods- DockerIf you would like to write documentation for another installation variant, please feel free to continue to do this and host it on your own personal blog, medium, Tumblr or any other short form publication service and we will be more than happy to add a link to that from our documentation, open a [PR](https://github.com/actualbudget/docs/pulls) and add it to the list in the [installation overview](https://github.com/actualbudget/docs/blob/master/docs/Installing/overview.md).-However, in doing so you would become responsible for these instructions, if they become out of date or people want in-depth help with them we will point them to you for assistance if the community is unable to help and if lots of people report issues with them we may have to remove the link altogether.+However, in doing so you would become responsible for these instructions, if they become out of date or people want in-depth help with them we will point them to you for assistance if the community is unable to help and if lots of people report issues with them we may have to remove the link altogether.## Document Standards@@ -210,3 +210,27 @@ $ GIT_USER=<Your GitHub username> yarn deploy```If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.++### Writing Good Release Notes++Create a Markdown file in the `changelog-unreleased` directory of the repository you’re contributing to named after the PR number. The file should contain front matter with a `category` key (defining which header to put the entry under) and an `authors` key (defining the author of the entry). The body of the file should contain the changelog entry. Keep it short and clear — ideally one sentence, and also non-technical (unless the category is “Maintenance”). Copy-paste the template below to get started!++```markdown+---+category: Features+authors: [YourGitHubUsername]+---++Add option to include exchange rate multiplier during import+```++Valid categories:++- `Features`: New features+- `Enhancements`: Improvements to existing features+- `Bugfix`: Bug fixes+- `Maintenance`: Internal changes that don’t directly affect users++The `authors` key should be an array with the GitHub usernames of the people who contributed to the PR. In most cases, this should just be you but you can add multiple people if needed.++Try to phrase your message as a command, e.g. “Add option to include exchange rate multiplier during import” rather than “Added option to include exchange rate multiplier during import” or “Adds option to include exchange rate multiplier during import.” Generally your message should match the PR title, but you can change it if you think it’s more clear.diff --git a/docs/Developers/releasing.md b/docs/Developers/releasing.mdindex 92a0f9bca2..2a5aef607e 100644--- a/docs/Developers/releasing.md+++ b/docs/Developers/releasing.md@@ -10,7 +10,7 @@ In the open-source version of Actual, all updates go through npm. There are twoBoth the API and web libraries are versioned together. This may change in the future, but because the web library also brings along its own backend it's easier to maintain a single version for now. That makes it clear which version the backend is regardless of library.Releasing @actual-app/api-### This generates a bundle for the API:+### Releasing @actual-app/api```bashyarn build:api@@ -31,7 +31,7 @@ In the root of actual (not just desktop-client), run this:./bin/package-browser```-This will compile both the backend and the frontend into a single directory in packages/desktop-client/build. This directory is all the files that need to be published. After bumping the version, publish desktop-client:+This will compile both the backend and the frontend into a single directory in `packages/desktop-client/build`. This directory is all the files that need to be published. After bumping the version, publish desktop-client:```bashcd packages/desktop-client@@ -50,3 +50,9 @@ For example:- `v23.3.1` - critical bugfix launched on the same date;- `v23.3.2` - another bugfix launched later in the month of March;- `v23.4.0` - first release launched on 9th of April, 2023;++### Release PRs++When cutting a release, create a PR to each of the `actual` and `actual-server` repositories. Make sure to name the branch `release/X.Y.Z` where `X.Y.Z` is the version number. This will trigger the release notes tooling, which will comment on your PR with the generated release notes. You can then copy-paste the release notes into the `Release-Notes.md` file in the `docs ` repository.++This automation will also delete all the outdated release note files from the `upcoming-release-notes` directory. Make sure you have merged the latest `master` into the release branch and allowed the automation to run before you merge the release PR so all of the files get properly cleaned up.