Merge changes I0373ac01,I7b543967,I537103eb into main
* changes: releng: fix the git push releng: clarify/update docs, add instructions after tag Fix is_maintenance_branch heuristic
This commit is contained in:
commit
3b902683e9
|
@ -448,6 +448,7 @@ stdenv.mkDerivation (finalAttrs: {
|
||||||
p.python-frontmatter
|
p.python-frontmatter
|
||||||
p.requests
|
p.requests
|
||||||
p.xdg-base-dirs
|
p.xdg-base-dirs
|
||||||
|
p.packaging
|
||||||
(p.toPythonModule xonsh.passthru.unwrapped)
|
(p.toPythonModule xonsh.passthru.unwrapped)
|
||||||
]
|
]
|
||||||
);
|
);
|
||||||
|
|
|
@ -57,12 +57,10 @@ Next, we do the publication with `python -m releng upload`:
|
||||||
`nix upgrade-nix`.
|
`nix upgrade-nix`.
|
||||||
* s3://releases/lix/lix-VERSION/ gets the following contents
|
* s3://releases/lix/lix-VERSION/ gets the following contents
|
||||||
* Binary tarballs
|
* Binary tarballs
|
||||||
* Docs: `manual/` (FIXME: should we actually do this? what about putting it
|
* Docs: `manual/`, primarily as an archive of old manuals
|
||||||
on docs.lix.systems? I think doing both is correct, since the Web site
|
|
||||||
should not be an archive of random old manuals)
|
|
||||||
* Docs as tarball in addition to web.
|
* Docs as tarball in addition to web.
|
||||||
* Source tarball
|
* Source tarball
|
||||||
* Docker image (FIXME: upload to forgejo registry and github registry [in the future][upload-docker])
|
* Docker image
|
||||||
* s3://docs/manual/lix/MAJOR
|
* s3://docs/manual/lix/MAJOR
|
||||||
* s3://docs/manual/lix/stable
|
* s3://docs/manual/lix/stable
|
||||||
|
|
||||||
|
@ -80,6 +78,7 @@ Next, we do the publication with `python -m releng upload`:
|
||||||
FIXME: automate branch-off to `release-*` branch.
|
FIXME: automate branch-off to `release-*` branch.
|
||||||
* **Manually** (FIXME?) switch back to the release branch, which now has the
|
* **Manually** (FIXME?) switch back to the release branch, which now has the
|
||||||
correct revision.
|
correct revision.
|
||||||
|
* Deal with the external systems (see sections below).
|
||||||
* Post!!
|
* Post!!
|
||||||
* Merge release blog post to [lix-website].
|
* Merge release blog post to [lix-website].
|
||||||
* Toot about it! https://chaos.social/@lix_project
|
* Toot about it! https://chaos.social/@lix_project
|
||||||
|
@ -87,22 +86,33 @@ Next, we do the publication with `python -m releng upload`:
|
||||||
|
|
||||||
[lix-website]: https://git.lix.systems/lix-project/lix-website
|
[lix-website]: https://git.lix.systems/lix-project/lix-website
|
||||||
|
|
||||||
[upload-docker]: https://git.lix.systems/lix-project/lix/issues/252
|
|
||||||
|
|
||||||
### Installer
|
### Installer
|
||||||
|
|
||||||
The installer is cross-built to several systems from a Mac using
|
The installer is cross-built to several systems from a Mac using `build-all.xsh` and `upload-to-lix.xsh` in the installer repo (FIXME: currently at least; maybe this should be moved here?).
|
||||||
`build-all.xsh` and `upload-to-lix.xsh` in the installer repo (FIXME: currently
|
|
||||||
at least; maybe this should be moved here?) .
|
|
||||||
|
|
||||||
It installs a binary tarball (FIXME: [it should be taught to substitute from
|
It installs a binary tarball (FIXME: [it should be taught to substitute from cache instead][installer-substitute]) from some URL; this is the `hydraJobs.binaryTarball`.
|
||||||
cache instead][installer-substitute])
|
The default URLs differ by architecture and are [configured here][tarball-urls].
|
||||||
from some URL; this is the `hydraJobs.binaryTarball`. The default URLs differ
|
|
||||||
by architecture and are [configured here][tarball-urls].
|
To automatically do the file changes for a new version, run `python3 set_version.py NEW_VERSION`, and submit the result for review.
|
||||||
|
|
||||||
[installer-substitute]: https://git.lix.systems/lix-project/lix-installer/issues/13
|
[installer-substitute]: https://git.lix.systems/lix-project/lix-installer/issues/13
|
||||||
[tarball-urls]: https://git.lix.systems/lix-project/lix-installer/src/commit/693592ed10d421a885bec0a9dd45e87ab87eb90a/src/settings.rs#L14-L28
|
[tarball-urls]: https://git.lix.systems/lix-project/lix-installer/src/commit/693592ed10d421a885bec0a9dd45e87ab87eb90a/src/settings.rs#L14-L28
|
||||||
|
|
||||||
|
### Web site
|
||||||
|
|
||||||
|
The website has various release-version dependent pieces.
|
||||||
|
You can update them with `python3 update_version.py NEW_VERSION`, which will regenerate the affected page sources.
|
||||||
|
|
||||||
|
These need the release to have been done first as they need hashes for tarballs and such.
|
||||||
|
|
||||||
|
### NixOS module
|
||||||
|
|
||||||
|
The NixOS module has underdeveloped releng in it.
|
||||||
|
Currently you have to do the whole branch-off dance manually to a `release-VERSION` branch and update the tarball URLs to point to the release versions manually.
|
||||||
|
|
||||||
|
FIXME: this should be unified with the `set_version.py` work in `lix-installer` and probably all the releng kept in here, or kept elsewhere.
|
||||||
|
Related: https://git.lix.systems/lix-project/lix/issues/439
|
||||||
|
|
||||||
## Infrastructure summary
|
## Infrastructure summary
|
||||||
|
|
||||||
* releases.lix.systems (`s3://releases`):
|
* releases.lix.systems (`s3://releases`):
|
||||||
|
|
|
@ -1,10 +1,13 @@
|
||||||
|
import logging
|
||||||
|
import argparse
|
||||||
|
import sys
|
||||||
|
|
||||||
from . import create_release
|
from . import create_release
|
||||||
from . import docker
|
from . import docker
|
||||||
from .environment import RelengEnvironment
|
from .environment import RelengEnvironment
|
||||||
from . import environment
|
from . import environment
|
||||||
import argparse
|
|
||||||
import sys
|
|
||||||
|
|
||||||
|
log = logging.getLogger(__name__)
|
||||||
|
|
||||||
def do_build(args):
|
def do_build(args):
|
||||||
if args.target == 'all':
|
if args.target == 'all':
|
||||||
|
@ -21,6 +24,9 @@ def do_tag(args):
|
||||||
create_release.do_tag_merge(force_tag=args.force_tag,
|
create_release.do_tag_merge(force_tag=args.force_tag,
|
||||||
no_check_git=args.no_check_git)
|
no_check_git=args.no_check_git)
|
||||||
|
|
||||||
|
log.info('Merged the release commit into your last branch, and switched to a detached HEAD of the artifact to be released.')
|
||||||
|
log.info('After you are done with releasing, switch to your previous branch and push that branch for review.')
|
||||||
|
|
||||||
|
|
||||||
def do_upload(env: RelengEnvironment, args):
|
def do_upload(env: RelengEnvironment, args):
|
||||||
create_release.setup_creds(env)
|
create_release.setup_creds(env)
|
||||||
|
|
|
@ -2,6 +2,7 @@ import json
|
||||||
import subprocess
|
import subprocess
|
||||||
import itertools
|
import itertools
|
||||||
import textwrap
|
import textwrap
|
||||||
|
import logging
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
import tempfile
|
import tempfile
|
||||||
import hashlib
|
import hashlib
|
||||||
|
@ -15,6 +16,8 @@ from .version import VERSION, RELEASE_NAME, MAJOR, OFFICIAL_RELEASE
|
||||||
from .gitutils import verify_are_on_tag, git_preconditions
|
from .gitutils import verify_are_on_tag, git_preconditions
|
||||||
from . import release_notes
|
from . import release_notes
|
||||||
|
|
||||||
|
log = logging.getLogger(__name__)
|
||||||
|
|
||||||
$RAISE_SUBPROC_ERROR = True
|
$RAISE_SUBPROC_ERROR = True
|
||||||
$XONSH_SHOW_TRACEBACK = True
|
$XONSH_SHOW_TRACEBACK = True
|
||||||
|
|
||||||
|
@ -55,6 +58,9 @@ def official_release_commit_tag(force_tag=False):
|
||||||
git commit -m @(message)
|
git commit -m @(message)
|
||||||
git tag @(['-f'] if force_tag else []) -a -m @(message) @(VERSION)
|
git tag @(['-f'] if force_tag else []) -a -m @(message) @(VERSION)
|
||||||
|
|
||||||
|
with open('releng/prev-git-branch.txt', 'w') as fh:
|
||||||
|
fh.write(prev_branch)
|
||||||
|
|
||||||
return prev_branch
|
return prev_branch
|
||||||
|
|
||||||
|
|
||||||
|
@ -235,6 +241,22 @@ def upload_artifacts(env: RelengEnvironment, noconfirm=False, no_check_git=False
|
||||||
print('[+] Upload manual')
|
print('[+] Upload manual')
|
||||||
upload_manual(env)
|
upload_manual(env)
|
||||||
|
|
||||||
|
prev_branch = None
|
||||||
|
try:
|
||||||
|
with open('releng/prev-git-branch.txt', 'r') as fh:
|
||||||
|
prev_branch = fh.read().strip()
|
||||||
|
except FileNotFoundError:
|
||||||
|
log.warn('Cannot find previous git branch file, skipping pushing git objects')
|
||||||
|
|
||||||
|
if prev_branch:
|
||||||
|
print('[+] git push to the repo')
|
||||||
|
# We have to push the ref to gerrit for review at least such that the
|
||||||
|
# commit is known, before we can push it as a tag.
|
||||||
|
if env.git_repo_is_gerrit:
|
||||||
|
git push @(env.git_repo) f'{prev_branch}:refs/for/{prev_branch}'
|
||||||
|
else:
|
||||||
|
git push @(env.git_repo) f'{prev_branch}:{prev_branch}'
|
||||||
|
|
||||||
print('[+] git push tag')
|
print('[+] git push tag')
|
||||||
git push @(['-f'] if force_push_tag else []) @(env.git_repo) f'{VERSION}:refs/tags/{VERSION}'
|
git push @(['-f'] if force_push_tag else []) @(env.git_repo) f'{VERSION}:refs/tags/{VERSION}'
|
||||||
|
|
||||||
|
|
|
@ -52,6 +52,7 @@ class RelengEnvironment:
|
||||||
releases_bucket: str
|
releases_bucket: str
|
||||||
docs_bucket: str
|
docs_bucket: str
|
||||||
git_repo: str
|
git_repo: str
|
||||||
|
git_repo_is_gerrit: bool
|
||||||
|
|
||||||
docker_targets: list[DockerTarget]
|
docker_targets: list[DockerTarget]
|
||||||
|
|
||||||
|
@ -79,6 +80,7 @@ STAGING = RelengEnvironment(
|
||||||
cache_store_overlay={'secret-key': 'staging.key'},
|
cache_store_overlay={'secret-key': 'staging.key'},
|
||||||
releases_bucket='s3://staging-releases',
|
releases_bucket='s3://staging-releases',
|
||||||
git_repo='ssh://git@git.lix.systems/lix-project/lix-releng-staging',
|
git_repo='ssh://git@git.lix.systems/lix-project/lix-releng-staging',
|
||||||
|
git_repo_is_gerrit=False,
|
||||||
docker_targets=[
|
docker_targets=[
|
||||||
# latest will be auto tagged if appropriate
|
# latest will be auto tagged if appropriate
|
||||||
DockerTarget('git.lix.systems/lix-project/lix-releng-staging',
|
DockerTarget('git.lix.systems/lix-project/lix-releng-staging',
|
||||||
|
@ -113,6 +115,7 @@ PROD = RelengEnvironment(
|
||||||
cache_store_overlay={'secret-key': 'prod.key'},
|
cache_store_overlay={'secret-key': 'prod.key'},
|
||||||
releases_bucket='s3://releases',
|
releases_bucket='s3://releases',
|
||||||
git_repo=guess_gerrit_remote(),
|
git_repo=guess_gerrit_remote(),
|
||||||
|
git_repo_is_gerrit=True,
|
||||||
docker_targets=[
|
docker_targets=[
|
||||||
# latest will be auto tagged if appropriate
|
# latest will be auto tagged if appropriate
|
||||||
DockerTarget('git.lix.systems/lix-project/lix',
|
DockerTarget('git.lix.systems/lix-project/lix',
|
||||||
|
|
|
@ -1,11 +1,24 @@
|
||||||
import subprocess
|
import subprocess
|
||||||
import json
|
from packaging.version import Version
|
||||||
|
|
||||||
from .version import VERSION
|
from .version import VERSION
|
||||||
|
|
||||||
|
|
||||||
|
def remote_is_plausible(url: str) -> bool:
|
||||||
|
return ('git.lix.systems' in url and 'lix-project/lix' in url) or ('gerrit.lix.systems' in url and url.endswith('lix'))
|
||||||
|
|
||||||
|
|
||||||
def version_compare(v1: str, v2: str):
|
def version_compare(v1: str, v2: str):
|
||||||
return json.loads($(nix-instantiate --eval --json --argstr v1 @(v1) --argstr v2 @(v2) --expr '{v1, v2}: builtins.compareVersions v1 v2'))
|
v1 = Version(v1)
|
||||||
|
v2 = Version(v2)
|
||||||
|
if v1 < v2:
|
||||||
|
return -1
|
||||||
|
elif v1 > v2:
|
||||||
|
return 1
|
||||||
|
elif v1 == v2:
|
||||||
|
return 0
|
||||||
|
else:
|
||||||
|
raise ValueError('these versions are beyond each others celestial plane')
|
||||||
|
|
||||||
|
|
||||||
def latest_tag_on_branch(branch: str) -> str:
|
def latest_tag_on_branch(branch: str) -> str:
|
||||||
|
@ -13,16 +26,18 @@ def latest_tag_on_branch(branch: str) -> str:
|
||||||
|
|
||||||
|
|
||||||
def is_maintenance_branch(branch: str) -> bool:
|
def is_maintenance_branch(branch: str) -> bool:
|
||||||
try:
|
"""
|
||||||
main_tag = latest_tag_on_branch('main')
|
Returns whether the given branch is probably a maintenance branch.
|
||||||
|
|
||||||
|
This uses a heuristic: `main` should have a newer tag than a given
|
||||||
|
maintenance branch if there has been a major release since that maintenance
|
||||||
|
branch.
|
||||||
|
"""
|
||||||
|
assert remote_is_plausible($(git remote get-url origin).strip())
|
||||||
|
main_tag = latest_tag_on_branch('origin/main')
|
||||||
current_tag = latest_tag_on_branch(branch)
|
current_tag = latest_tag_on_branch(branch)
|
||||||
|
|
||||||
return version_compare(current_tag, main_tag) < 0
|
return version_compare(current_tag, main_tag) < 0
|
||||||
except subprocess.CalledProcessError:
|
|
||||||
# This is the case before Lix releases 2.90, since main *has* no
|
|
||||||
# release tag on it.
|
|
||||||
# FIXME: delete this case after 2.91
|
|
||||||
return False
|
|
||||||
|
|
||||||
|
|
||||||
def verify_are_on_tag():
|
def verify_are_on_tag():
|
||||||
|
|
Loading…
Reference in a new issue