WIP

.gitea/release.yaml

@@ -1 +1 @@
-version_descriptor: version.txt
+version_descriptor: setup.py

.gitea/workflows/check.yaml

@@ -23,6 +23,50 @@ jobs:
 
       - run: set -u; echo "$RELEASE_PROJECT_CURRENT_VERSION"
 
+  test-sync-versions:
+    runs-on: action-runner
+    steps:
+      - uses: actions/checkout@v4
+
+      # skip login locally
+      - if: github.repository == 'actions/release'
+        uses: https://gitea.puzzleyou.net/actions/configure-runner-environment@master
+
+      - run: |
+          echo "1.33.7" > /tmp/version-test.txt
+          echo "0.0.42" > /tmp/other-version.txt
+
+      - uses: ./declare
+        with:
+          configure_runner_environment: false
+          version_descriptor: /tmp/version-test.txt
+          artefact_type: oci_image
+          artefact_name: default-image
+          artefact_version_descriptor: /tmp/other-version.txt
+
+      - uses: ./sync-versions
+
+      - run: test "$(cat /tmp/version-test.txt)" = "$RELEASE_PROJECT_PLANNED_VERSION"
+      - run: test "$(cat /tmp/other-version.txt)" = "$RELEASE_PROJECT_PLANNED_VERSION"
+
+  test-is-not-yet-released:
+    runs-on: action-runner
+    steps:
+      - uses: actions/checkout@v4
+
+      # skip login locally
+      - if: github.repository == 'actions/release'
+        uses: https://gitea.puzzleyou.net/actions/configure-runner-environment@master
+
+      - uses: ./declare
+        with:
+          configure_runner_environment: false
+          version_descriptor: test-assets/version.txt
+
+      - uses: ./check-is-not-released
+        with:
+          configure_runner_environment: false
+
   test-declare-with-release-yaml:
     runs-on: action-runner
     steps:
@@ -91,12 +135,21 @@ jobs:
           repository: europe-docker.hetzner.cloud/puzzleyou/helm
           condition: always
 
-      - name: ensure that environment variables are set
+      - name: ensure that default artefact is set
+        run: env | grep "RELEASE_IMAGE_LOCAL_NAME_DEFAULT_IMAGE"
+
+      - name: ensure that additional artefact is set
         run: env | grep "RELEASE_IMAGE_LOCAL_NAME_SOME_DOCKER_IMAGE"
 
       - name: dump release environment variables
         run: env | grep "RELEASE_"
 
+      - name: check version
+        run: echo "$RELEASE_PROJECT_CURRENT_VERSION" | grep "1.33.7"
+
+      - name: check state file is set
+        run: set -u; echo "$RELEASE_ACTION_STATEFILE"
+
       - name: dump project description
         uses: ./dump
 

.gitea/workflows/release.yaml

@@ -14,4 +14,4 @@ jobs:
     runs-on: action-runner
     steps:
       - uses: actions/checkout@v4
-      - uses: ./release
+      - uses: ./

action.yaml

@@ -0,0 +1 @@
+release/action.yaml

check-is-not-released/action.yaml

@@ -0,0 +1,48 @@
+name: "check not released"
+description: "ensure that there is no release with the current version"
+
+inputs:
+  configure_runner_environment:
+    required: false
+    default: true
+
+runs:
+  using: composite
+  steps:
+    - if: inputs.configure_runner_environment == 'true'
+      uses: https://gitea.puzzleyou.net/actions/configure-runner-environment@master
+
+    - name: declare project if neccessary
+      run: |
+        if [[ ! -z "${RELEASE_PROJECT_CURRENT_VERSION}" ]]; then
+          echo "already set up."
+          exit 0
+        fi
+
+        nix run ${{ github.action_path }} -- \
+          declare \
+          --release-yaml-filename ".gitea/release.yaml" \
+          --gitea-instance "https://gitea.puzzleyou.net" \
+          --release-repository-name "${{ github.repository }}" \
+          --release-ref-name "${{ github.ref_name }}" \
+          --release-run-number "${{ github.run_number }}" \
+          --release-commit-sha "${{ github.sha }}" \
+          --write-env-vars-to-filename "$GITHUB_ENV"
+
+    - name: check release state
+      run: |
+        set +e
+
+        nix run ${{ github.action_path }} -- \
+          dump \
+          --state "${RELEASE_ACTION_STATEFILE}" \
+          | grep "is already released: True"
+        IS_RELEASED_EXIT_CODE=$?
+
+        if [[ "$IS_RELEASED_EXIT_CODE" -eq 0 ]]; then
+          VERSION="$RELEASE_PROJECT_CURRENT_VERSION"
+          echo "Project is already released with version ${VERSION}."
+          exit -1
+        else
+          echo "Project is not yet released."
+        fi

declare/action.yaml

@@ -102,72 +102,18 @@ runs:
     - if: inputs.configure_runner_environment == 'true'
       uses: https://gitea.puzzleyou.net/actions/configure-runner-environment@master
 
-    - name: init action state
-      run: |
-        if [[ ! -z "${RELEASE_PROJECT_CURRENT_VERSION}" ]]; then
-          echo "already set up."
-          exit 0
-        fi
-
-        RELEASE_ACTION_STATEFILE=$(mktemp)
-        echo "[release] statefile: $RELEASE_ACTION_STATEFILE"
-        echo "RELEASE_ACTION_STATEFILE="$RELEASE_ACTION_STATEFILE"" \
-          >> "$GITHUB_ENV"
-
     - name: declare release project
-      if: inputs.version_descriptor == ''
       run: |
-        if [[ ! -z "${RELEASE_PROJECT_CURRENT_VERSION}" ]]; then
-          echo "already set up."
-          exit 0
-        fi
-
-        if [[ "${{ github.ref_name }}" == "master" || "${{ github.ref_name }}" == "main" ]]; then
-          IS_PRE_RELEASE="0"
-        else
-          IS_PRE_RELEASE="1"
-        fi
-
         nix run ${{ github.action_path }} -- \
           declare \
-          --state "${RELEASE_ACTION_STATEFILE}" \
           --release-yaml-filename "${{ inputs.filename }}" \
-          --gitea-instance "${{ inputs.gitea_instance }}" \
-          --release-repository-name "${{ inputs.repository }}" \
-          --release-ref-name "${{ github.ref_name }}" \
-          --release-run-number "${{ github.run_number }}" \
-          --release-commit-sha "${{ github.sha }}" \
-          --is-pre-release "${IS_PRE_RELEASE}"
-
-        nix run ${{ github.action_path }} -- \
-          dump \
-          --state "${RELEASE_ACTION_STATEFILE}" \
-          --write-env-vars-to-filename "$GITHUB_ENV"
-
-    - name: declare release project
-      if: inputs.version_descriptor != ''
-      run: |
-        if [[ ! -z "${RELEASE_PROJECT_CURRENT_VERSION}" ]]; then
-          echo "already set up."
-          exit 0
-        fi
-
-        if [[ "${{ github.ref_name }}" == "master" || "${{ github.ref_name }}" == "main" ]]; then
-          IS_PRE_RELEASE="0"
-        else
-          IS_PRE_RELEASE="1"
-        fi
-
-        nix run ${{ github.action_path }} -- \
-          declare \
-          --state "${RELEASE_ACTION_STATEFILE}" \
           --version-descriptor "${{ inputs.version_descriptor }}" \
           --gitea-instance "${{ inputs.gitea_instance }}" \
           --release-repository-name "${{ inputs.repository }}" \
           --release-ref-name "${{ github.ref_name }}" \
           --release-run-number "${{ github.run_number }}" \
           --release-commit-sha "${{ github.sha }}" \
-          --is-pre-release "${IS_PRE_RELEASE}" \
+          --write-env-vars-to-filename "$GITHUB_ENV"
 
         if [[ ! -z "${{ inputs.artefact_type }}" ]]; then
           nix run ${{ github.action_path }} -- \
@@ -194,8 +140,3 @@ runs:
             --deployment-namespace "${{ inputs.deployment_namespace }}" \
             --deployment-repository "${{ inputs.deployment_repository }}"
         fi
-
-        nix run ${{ github.action_path }} -- \
-          dump \
-          --state "${RELEASE_ACTION_STATEFILE}" \
-          --write-env-vars-to-filename "$GITHUB_ENV"

flake.nix

@@ -18,6 +18,7 @@
           toml
           requests
           pyyaml
+          packaging
         ]);
 
         pythonPackage = pkgs.python3Packages.buildPythonPackage {
@@ -44,6 +45,7 @@
                 requests
                 pythonPackage
                 pyyaml
+                packaging
               ];
             }
             (builtins.readFile ./src/main.py)

justfile

@@ -24,4 +24,17 @@ test-workflows:
     --workflows ./.gitea/workflows/check.yaml \
     --job test-declare-default
 
+  act_runner exec \
+    --image "-self-hosted" \
+    --event pull_request \
+    --workflows ./.gitea/workflows/check.yaml \
+    --job test-is-not-yet-released
+
+  act_runner exec \
+    --image "-self-hosted" \
+    --event pull_request \
+    --workflows ./.gitea/workflows/check.yaml \
+    --job test-sync-versions
+
+  # TODO
   # --image "europe-docker.pkg.dev/puzzle-and-play/docker/action-runner-job:latest" \

release/action.yaml

@@ -11,13 +11,21 @@ inputs:
     required: false
     default: true
 
+  build_run:
+    required: false
+    description: "commands to run before publishing artefacts"
+    default: ""
+
+  sync_versions:
+    required: false
+    default: false
+
 runs:
   using: composite
   steps:
     - if: inputs.configure_runner_environment == 'true'
       uses: https://gitea.puzzleyou.net/actions/configure-runner-environment@master
 
-    # TODO duplicate code (declare/action.yaml)
     - name: declare project if neccessary
       run: |
         if [[ ! -z "${RELEASE_PROJECT_CURRENT_VERSION}" ]]; then
@@ -25,33 +33,27 @@ runs:
           exit 0
         fi
 
-        RELEASE_ACTION_STATEFILE=$(mktemp)
-        echo "[release] statefile: $RELEASE_ACTION_STATEFILE"
-        echo "RELEASE_ACTION_STATEFILE="$RELEASE_ACTION_STATEFILE"" \
-          >> "$GITHUB_ENV"
-
-        if [[ "${{ github.ref_name }}" == "master" || "${{ github.ref_name }}" == "main" ]]; then
-          IS_PRE_RELEASE="0"
-        else
-          IS_PRE_RELEASE="1"
-        fi
-
         nix run ${{ github.action_path }} -- \
           declare \
-          --state "${RELEASE_ACTION_STATEFILE}" \
           --release-yaml-filename ".gitea/release.yaml" \
           --gitea-instance "https://gitea.puzzleyou.net" \
           --release-repository-name "${{ github.repository }}" \
           --release-ref-name "${{ github.ref_name }}" \
           --release-run-number "${{ github.run_number }}" \
           --release-commit-sha "${{ github.sha }}" \
-          --is-pre-release "${IS_PRE_RELEASE}"
-
-        nix run ${{ github.action_path }} -- \
-          dump \
-          --state "${RELEASE_ACTION_STATEFILE}" \
           --write-env-vars-to-filename "$GITHUB_ENV"
 
+    - name: sync versions
+      if: inputs.sync_versions == 'true'
+      run: |
+        nix run ${{ github.action_path }} -- \
+          sync-versions \
+          --state "${RELEASE_ACTION_STATEFILE}"
+
+    - name: run build commands
+      if: inputs.build_run != ''
+      run: ${{ inputs.build_run }}
+
     - name: publish artefacts
       run: |
         nix run ${{ github.action_path }} -- \

src/main.py

@@ -2,6 +2,8 @@ import pickle
 import re
 from argparse import ArgumentParser
 from dataclasses import replace
+from os import path
+from tempfile import gettempdir
 from typing import Optional
 
 import yaml
@@ -231,15 +233,29 @@ def make_deployment(type: str,
     return DeploymentDescription(deployment=deployment, **maybe_condition)
 
 
+def sync_versions(project_description: ProjectDescription):
+    planned_version = project_description.planned_version
+
+    def sync(descriptor_filename: str):
+        v = versioning.use_any(descriptor_filename)
+        v.version = planned_version
+        v.store()
+
+    sync(project_description.version_descriptor)
+
+    for artefact in project_description.artefacts:
+        if artefact.version_descriptor is not None:
+            sync(artefact.version_descriptor)
+
+
 if __name__ == '__main__':
     parser = ArgumentParser()
     parser.add_argument('action', choices=[
-        # TODO missing: adjust version (development)
-        # TODO missing: check if release already exists
         'declare',
         'check',
         'add-artefact',
         'add-deployment',
+        'sync-versions',
         'publish-artefacts',
         'update-deployments',
         'create-release',
@@ -262,7 +278,7 @@ if __name__ == '__main__':
         else:
             raise Exception('flag can be "0" or "1". got: %s' % val)
 
-    parser.add_argument('--state', required=True)
+    parser.add_argument('--state', type=nullable_string)
     parser.add_argument('--version-descriptor', type=nullable_string)
     parser.add_argument('--release-yaml-filename', type=nullable_string)
     parser.add_argument('--dry-run', type=true_or_false)
@@ -296,6 +312,8 @@ if __name__ == '__main__':
     parser.add_argument('--write-env-vars-to-filename')
 
     args = parser.parse_args()
+    state_file = (args.state
+                  or str(path.join(gettempdir(), 'release_project_state')))
 
     def clean_repository_name(name: str) -> str:
         if name.startswith('//'):
@@ -304,13 +322,22 @@ if __name__ == '__main__':
             return name
 
     if args.action == 'declare':
-        if args.release_yaml_filename is None:
-            project_description = make_project_description(
-                args.version_descriptor)
-        else:
+        if args.version_descriptor is None:
             with open(args.release_yaml_filename, 'r') as f:
                 project_description = parse_project_description(
                     yaml.safe_load(f))
+        else:
+            project_description = make_project_description(
+                args.version_descriptor)
+
+        if args.is_pre_release is None:
+            assert args.release_ref_name is not None
+
+            is_pre_release = not any(
+                map(lambda rn: rn in args.release_ref_name,
+                    ['master', 'main']))
+        else:
+            is_pre_release = args.is_pre_release
 
         project_description = replace(
                 project_description,
@@ -320,12 +347,12 @@ if __name__ == '__main__':
                     args.release_ref_name,
                     args.release_run_number,
                     args.release_commit_sha,
-                    args.is_pre_release))
+                    is_pre_release))
 
-        save_project_description(args.state, project_description)
+        save_project_description(state_file, project_description)
 
     elif args.action == 'add-artefact':
-        project_description = load_project_description(args.state)
+        project_description = load_project_description(state_file)
 
         artefact = make_artefact(args.artefact_type,
                                  args.artefact_repository,
@@ -340,10 +367,10 @@ if __name__ == '__main__':
             project_description,
             artefacts=project_description.artefacts + [artefact])
 
-        save_project_description(args.state, project_description)
+        save_project_description(state_file, project_description)
 
     elif args.action == 'add-deployment':
-        project_description = load_project_description(args.state)
+        project_description = load_project_description(state_file)
 
         deployment = make_deployment(args.deployment_type,
                                      args.deployment_release_name,
@@ -356,38 +383,46 @@ if __name__ == '__main__':
             project_description,
             deployments=project_description.deployments + [deployment])
 
-        save_project_description(args.state, project_description)
+        save_project_description(state_file, project_description)
+
+    elif args.action == 'sync-versions':
+        project_description = load_project_description(state_file)
+        sync_versions(project_description)
 
     elif args.action == 'publish-artefacts':
-        project_description = load_project_description(args.state)
+        project_description = load_project_description(state_file)
         publish_artefacts(project_description, args.dry_run)
 
     elif args.action == 'update-deployments':
-        project_description = load_project_description(args.state)
+        project_description = load_project_description(state_file)
         update_deployments(project_description, args.dry_run)
 
     elif args.action == 'create-release':
-        project_description = load_project_description(args.state)
+        project_description = load_project_description(state_file)
         create_release(project_description, args.dry_run)
 
     elif args.action == 'dump':
-        project_description = load_project_description(args.state)
+        project_description = load_project_description(state_file)
         dump_project_description(project_description)
 
     elif args.action == 'check':
-        project_description = load_project_description(args.state)
+        project_description = load_project_description(state_file)
 
     else:
         raise NotImplementedError()
 
     assert project_description is not None
+    assert state_file is not None
 
     env_var_filename = args.write_env_vars_to_filename
     if env_var_filename is not None:
-        env_vars = project_description.environment_variables
+        env_vars = {
+            'RELEASE_ACTION_STATEFILE': state_file,
+            **project_description.environment_variables
+        }
 
         assert not any(map(lambda v: '"' in v, env_vars.values()))
 
         with open(env_var_filename, 'a') as f:
             f.write(
-                '\n'.join(map(lambda it: '%s="%s"' % it, env_vars.items())))
+                '\n'.join(map(lambda it: '%s=%s' % it, env_vars.items())))

src/release/common.py

@@ -0,0 +1,12 @@
+from packaging.version import parse as parse_version
+from semver import Version
+
+
+def python_version_str(version: Version) -> str:
+    return ('%d.%d.%d' % (version.major, version.minor, version.patch)) \
+        + ('' if version.prerelease is None else '.%s' % version.prerelease)
+
+
+def python_parse_version(txt: str) -> Version:
+    version = parse_version(txt)
+    return Version(*version.release, version.pre)

src/release/project.py

@@ -6,6 +6,7 @@ from itertools import chain
 from typing import Optional, Union
 
 from release import toolkit, versioning
+from release.common import python_version_str
 from release.context import ReleaseContext
 from release.versioning import Version
 
@@ -20,11 +21,6 @@ def _normalize_env_var_fragment(txt: str) -> str:
     return txt.upper().replace('-', '_').replace('.', '_')
 
 
-def _python_version_str(version: Version) -> str:
-    return ('%d.%d.%d' % (version.major, version.minor, version.patch)) \
-        + ('' if version.prerelease is None else '.%s' % version.prerelease)
-
-
 @dataclass(frozen=True)
 class OciImageReleaseInfo:
     image_name: str
@@ -118,7 +114,7 @@ class Wheel:
         return WheelReleaseInfo(
             pattern=self.pattern,
             repository=self.repository,
-            version_str=_python_version_str(version))
+            version_str=python_version_str(version))
 
 
 @dataclass(frozen=True)
@@ -140,7 +136,7 @@ class Sdist:
         return SdistReleaseInfo(
             filename=self.filename,
             repository=self.repository,
-            version_str=_python_version_str(version))
+            version_str=python_version_str(version))
 
 
 @dataclass(frozen=True)

src/release/release.py

@@ -9,6 +9,8 @@ from release.project import (DeploymentCondition, HelmRelease, HelmReleaseInfo,
                              SdistReleaseInfo, Tarball, TarballReleaseInfo,
                              Wheel, WheelReleaseInfo)
 
+DEFAULT_PACKAGE_OWNER = 'puzzleYOU'
+
 
 class Cli:
     def __init__(self, dry_run: bool):
@@ -66,8 +68,9 @@ def publish_tarball(info: TarballReleaseInfo, cli: Cli):
         '--upload-file', info.filename,
         '-i',
         '-X', 'PUT',
-        '%s/api/packages/puzzleYOU/generic/%s/%s/%s' % (  # TODO owner
+        '%s/api/packages/%s/generic/%s/%s/%s' % (
             info.repository,
+            DEFAULT_PACKAGE_OWNER,
             info.package_name,
             info.version_str,
             path.basename(info.filename)))

src/release/tests/project.py

@@ -293,11 +293,12 @@ class TestProjectDescription(TestCase):
                 img.make_release_info(release_context, release_version))
 
     def test_project_release_info(self):
-        project_0 = ProjectDescription(version_descriptor='version.txt')
+        project_0 = ProjectDescription(
+            version_descriptor='test-assets/version.txt')
         self.assertIsNone(project_0.release_info)
 
         project_pre = ProjectDescription(
-            version_descriptor='version.txt',
+            version_descriptor='test-assets/version.txt',
             context=ReleaseContext(
                 repository_name='resi',
                 ref_name='testing',
@@ -308,16 +309,16 @@ class TestProjectDescription(TestCase):
 
         self.assertEqual(
             ProjectReleaseInfo(
-                gitea_release_title='Version 0.0.1-dev42',
+                gitea_release_title='Version 1.33.7-dev42',
                 gitea_release_description='',
                 gitea_is_prerelease=True,
                 gitea_git_commitish='PROBABLY_BROKEN',
-                git_tags=['v0.0.1-dev42', 'development'],
+                git_tags=['v1.33.7-dev42', 'development'],
             ),
             project_pre.release_info)
 
         project = ProjectDescription(
-            version_descriptor='version.txt',
+            version_descriptor='test-assets/version.txt',
             context=ReleaseContext(
                 repository_name='resi',
                 ref_name='master',
@@ -328,11 +329,11 @@ class TestProjectDescription(TestCase):
 
         self.assertEqual(
             ProjectReleaseInfo(
-                gitea_release_title='Version 0.0.1',
+                gitea_release_title='Version 1.33.7',
                 gitea_release_description='',
                 gitea_is_prerelease=False,
                 gitea_git_commitish='PROBABLY_BROKEN',
-                git_tags=['v0.0.1', 'v0.0', 'v0', 'latest'],
+                git_tags=['v1.33.7', 'v1.33', 'v1', 'latest'],
             ),
             project.release_info)
 

src/release/tests/versioning.py

@@ -18,12 +18,12 @@ def _test_can_read_version(test, filename, expected):
 
 def _test_can_write_version(test, filename):
     v = use_any(_asset_path(filename))
-    v.version = Version(1, 33, 7)
+    v.version = Version(1, 33, 7, 42)
 
     with NamedTemporaryFile() as tf:
         v.store(tf.name)
         v2 = use_any(tf.name)
-        test.assertEqual(v2.version, Version(1, 33, 7))
+        test.assertEqual(v2.version, Version(1, 33, 7, 42))
 
 
 class TestSetupPy(TestCase):

src/release/versioning.py

@@ -6,6 +6,8 @@ from logging import getLogger
 import toml
 from semver import Version
 
+from release.common import python_parse_version, python_version_str
+
 logger = getLogger(__name__)
 RE_SETUP_PY = re.compile(r'version\s?=\s?[\'"](.*)[\'"]')
 
@@ -24,12 +26,13 @@ class SetupPy:
 
         self.filename = filename
         self.content = content
-        self.version = Version.parse(version_string.group(1))
+        self.version = python_parse_version(version_string.group(1))
 
     def store(self, destination=None):
         destination = destination or self.filename
         edited = RE_SETUP_PY.sub(
-            'version=\'%s\'' % self.version, self.content)
+            'version=\'%s\'' % python_version_str(self.version),
+            self.content)
 
         with open(destination, 'w') as f:
             f.write(edited)

sync-versions/action.yaml

@@ -0,0 +1,13 @@
+name: "sync version descriptors"
+description: "update all version descriptors to the planned version."
+
+inputs: {}
+
+runs:
+  using: composite
+  steps:
+    - name: sync versions
+      run: |
+        nix run ${{ github.action_path }} -- \
+          sync-versions \
+          --state "${RELEASE_ACTION_STATEFILE}"

version.txt

@@ -1 +0,0 @@
-0.0.1