napcok/calamares
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Docs: massage the release-howto notes

Browse Source
This commit is contained in:
Adriaan de Groot 2021-03-14 21:49:15 +01:00
parent 1998405dbb
commit a5091c8c3b
2 changed files with 35 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
CHANGES
View File

@ -12,6 +12,7 @@ website will have to do for older versions.
This release contains contributions from (alphabetically by first name): This release contains contributions from (alphabetically by first name):
- Anke Boersma - Anke Boersma
- Anubhav Choudhary - Anubhav Choudhary
- Neal Gompa
## Core ## ## Core ##
- Uploading your log files (in case of installation failure) has been - Uploading your log files (in case of installation failure) has been
@ -23,6 +24,8 @@ This release contains contributions from (alphabetically by first name):
## Modules ## ## Modules ##
- A new QML-based *finishedq* module has been added. (Thanks Anke) - A new QML-based *finishedq* module has been added. (Thanks Anke)
- The *packages* module no longer supports *urpmi*; no Calamares-
consumers with that package manager seem to exist. (Thanks Neal)
- The *users* module now can set a fixed username and prevent editing. - The *users* module now can set a fixed username and prevent editing.
The *presets* configuration entry in `users.conf` can set a *loginName* The *presets* configuration entry in `users.conf` can set a *loginName*
and a *fullName* and (independently) enable or disable editing of and a *fullName* and (independently) enable or disable editing of

54
ci/RELEASE.md
View File

@ -11,8 +11,29 @@
> >
> Most things are automated through the release script [RELEASE.sh](RELEASE.sh) > Most things are automated through the release script [RELEASE.sh](RELEASE.sh)
## (0) During a release cycle
* Fetch latest translations from Transifex. We only push / pull translations
from *calamares* branch, so longer-lived branches (e.g. 3.1.x) don't get
translation updates. This is to keep the translation workflow simple.
The script automatically commits changes to the translations. It's ok
to do this during a release cycle. Run `sh ci/txpull.sh`
to fetch translations and commit the changes in one go.
* Push the strings to Transifex. From a checkout, run `ci/txpush.sh`
* Update the list of enabled translation languages in `CMakeLists.txt`.
Check the [translation site][transifex] for the list of languages with
fairly complete translations, or use `ci/txstats.py --edit` for an automated
suggestion. If there are changes, commit them.
## (1) Preparation ## (1) Preparation
* Drop the RC variable to 0 in `CMakeLists.txt`, *CALAMARES_VERSION_RC*.
* Edit `CHANGES` and set the date of the release.
* Commit both. This is usually done with commit-message
*Changes: pre-release housekeeping*.
## (2) Release Preparation
* Make sure all tests pass. * Make sure all tests pass.
``` ```
make make
@ -22,27 +43,16 @@
an additional environment variable to be set for some tests, which will an additional environment variable to be set for some tests, which will
destroy an attached disk. This is not always desirable. There are some destroy an attached disk. This is not always desirable. There are some
sample config-files that are empty and which fail the config-tests. sample config-files that are empty and which fail the config-tests.
* Pull latest translations from Transifex. We only push / pull translations Note that the release script (see below) also runs the tests and
from master, so longer-lived branches (e.g. 3.1.x) don't get translation will bail out if any fail.
updates. This is to keep the translation workflow simple. The script * Make sure the translations are up-to-date. There is logic to check
automatically commits changes to the translations. for changes in translations: a movable tag *translations* indicates
``` when translations were last pushed, and the logic tries to enforce a
sh ci/txpull.sh week of latency between push-translations and a release, to allow
``` translators to catch up. Run `ci/txcheck.sh` to confirm this.
* Update the list of enabled translation languages in `CMakeLists.txt`. Run `ci/txcheck.sh --cleanup` to tidy up afterwards, and possibly pass
Check the [translation site][transifex] for the list of languages with `-T` to the release script to skip the translation-age check if you
fairly complete translations, or use `ci/txstats.py` for an automated feel it is warranted.
suggestion. If there are changes, commit them.
* Push the changes.
* Check defaults in `settings.conf` and other configuration files.
* Drop the RC variable to 0 in `CMakeLists.txt`, *CALAMARES_VERSION_RC*.
* Edit `CHANGES` and set the date of the release.
* Commit both. This is usually done with commit-message
*Changes: pre-release housekeeping*.
## (2) Release Day
* Run the helper script `ci/RELEASE.sh` or follow steps below. * Run the helper script `ci/RELEASE.sh` or follow steps below.
The script checks: The script checks:
- for uncommitted local changes, - for uncommitted local changes,
@ -119,7 +129,7 @@ ssb rsa3072/0xCFDDC96F12B1915C
the Calmares site or as part of a release announcement). the Calmares site or as part of a release announcement).
- Send the updated key to keyservers with `gpg --send-keys <keyid>` - Send the updated key to keyservers with `gpg --send-keys <keyid>`
- Optional: sanitize the keyring for use in development machines. - Optional: sanitize the keyring for use in development machines.
Export the current subkeys of the master key and keep **only** those Export the current subkeys of the primary key and keep **only** those
secret keys around. There is documentation secret keys around. There is documentation
[here](https://blog.tinned-software.net/create-gnupg-key-with-sub-keys-to-sign-encrypt-authenticate/) [here](https://blog.tinned-software.net/create-gnupg-key-with-sub-keys-to-sign-encrypt-authenticate/)
but be careful. but be careful.