simonmichael/hledger
1
1
Fork 0
mirror of https://github.com/simonmichael/hledger.git synced 2024-09-19 10:17:35 +03:00
Code Issues Projects Releases Wiki Activity

;doc: RELEASING: glossary updates, test releases

Browse Source
This commit is contained in:
Simon Michael 2022-01-02 13:07:47 -10:00
parent 51fac9949f
commit ebf4d09537
1 changed files with 19 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
RELEASING.md
View File

@ -8,24 +8,25 @@ Tips for hledger release managers and maintainers.
## Glossary
| | |
|-----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|
| *Full release* | A release of all the core packages (hledger-lib, hledger, hledger-ui, hledger-web) |
| *Partial release* | A release of only some of the core packages |
| *Mixed release* | A release where some of the core packages have different versions (due to previous partial release) |
| *Test release* | A release that is published on github, but not hackage/stackage. These test the release process (and secondly, generate fresh binaries for early adopters) |
| | |
| *hledger repo* | The `hledger` git repository, containing the core hledger tools and docs. Official public copy: github.com/simonmichael/hledger |
| *"master"* | The `master` branch in the hledger repo; the main line of hledger development |
| *release branch* | Branches named `MAJORVERSION-branch` in the hledger repo, eg `1.24-branch`. Releases are made from these. |
| | |
| *site repo* | The `hledger_website` git repository, containing the hledger.org website and additional docs. Usually checked out under the hledger repo as `site/`. |
| *"site"* | The `master` branch in the site repo, used to generate <https://hledger.org>. |
| | |
| *version* | the 2 or 3-part dotted version number that names a hledger release: MA.JOR or MA.JOR.MINOR. |
| *MAJORVER* | Just the MA.JOR part, eg 1.24 |
| *OLD*, *NEW* | Previous and new pending release versions. Examples: 1.24 -> 1.24.1, 1.24.1 -> 1.24.2, 1.24.2 -> 1.25. |
| | |
| | |
|-----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| *Release* | A named, tagged, documented, usually announced snapshot of the software plus any related artifacts like executable binaries. |
| *Version number* | A 2-4 part dotted number naming a hledger release, see examples below. For unreleased code it ends with .99, eg a post-1.25 / pre-1.26 build of master will show `1.25.99`. |
| *Version string* | A line of text describing a hledger binary, shown by the `--version` flag. It includes the tool name, version number, commit hash and date, machine architecture, etc. |
| *Major release* | Major releases include significant changes like new features and incompatible API changes. hledger major releases normally happen at start of each quarter's last month (Mar 1, Jun 1, Sep 1, Dec 1). Example version number: `1.25` |
| *Minor release* | Minor releases include only bug fixes, without API changes. These happen only when needed, to fix significant bugs in a major release. Example version number: `1.25.2` |
| *Fixup release* | Fixup releases include only fixes for packaging errors, and no changes to the hledger software. These should be rare. Example version number: `1.25.0.1` or `1.25.2.1` |
| *Test release* | A snapshot of development code, published only on github, not hackage, to exercise the release process and provide fresh binaries for testers/early adopters. These can happen any time but typically at the start of a quarter's first or second month. Example version number: `1.25.20220102` |
| *Full release* | A release of all the core hledger packages (hledger-lib, hledger, hledger-ui, hledger-web) with all of them using the same version number. Major releases are always full releases. |
| *Partial release* | A release of only some of the core packages. Minor releases are sometimes partial. |
| *Mixed release* | A release where some packages have different versions, because of a previous partial release. Minor releases are sometimes mixed. |
| *hledger repo* | The `hledger` git repository, containing the core hledger tools and docs. Official public copy: github.com/simonmichael/hledger |
| *"master"* | The `master` branch in the hledger repo; the main line of hledger development |
| *release&nbsp;branch* | Branches named `MAJORVERSION-branch` in the hledger repo, eg `1.24-branch`. Releases are made from these. |
| *site repo* | The `hledger_website` git repository, containing the hledger.org website and additional docs. Usually checked out under the hledger repo as `site/`. |
| *"site"* | The `master` branch in the site repo, used to generate <https://hledger.org>. |
| *MAJORVER* | Just the MA.JOR part, eg 1.24 |
| *OLD*, *NEW* | Previous and new pending release versions. Examples: 1.24 -> 1.24.1, 1.24.1 -> 1.24.2, 1.24.2 -> 1.25. |
## 2021-12