WIP

.gitea/release.yaml

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

.gitea/workflows/check.yaml

@@ -23,29 +23,18 @@ jobs:
 
       - run: set -u; echo "$RELEASE_PROJECT_CURRENT_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:
       - uses: actions/checkout@v4
 
+      - uses: ./declare
+        with:
+          configure_runner_environment: false
+          filename: ./src/release/tests/assets/release.yaml
+
+      - run: set -u; echo "$RELEASE_PROJECT_CURRENT_VERSION"
+
       # skip login locally
       - if: github.repository == 'actions/release'
         uses: https://gitea.puzzleyou.net/actions/configure-runner-environment@master
@@ -53,9 +42,6 @@ jobs:
       - uses: ./release
         with:
           dry_run: true
-          configure_runner_environment: false
-
-      - run: set -u; echo "$RELEASE_PROJECT_CURRENT_VERSION"
 
   test-declare-directly:
     runs-on: action-runner
@@ -109,21 +95,12 @@ jobs:
           repository: europe-docker.hetzner.cloud/puzzleyou/helm
           condition: always
 
-      - name: ensure that default artefact is set
+      - name: ensure that environment variables are 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,5 @@ jobs:
     runs-on: action-runner
     steps:
       - uses: actions/checkout@v4
-      - uses: ./
+      - uses: ./declare # TODO single action
+      - uses: ./release

action.yaml

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

check-is-not-released/action.yaml

@@ -1,48 +0,0 @@
-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,18 +102,57 @@ runs:
     - if: inputs.configure_runner_environment == 'true'
       uses: https://gitea.puzzleyou.net/actions/configure-runner-environment@master
 
-    - name: declare release project
+    - name: init action state
       run: |
+        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 [[ "${{ 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 [[ "${{ 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 }}" \
-          --write-env-vars-to-filename "$GITHUB_ENV"
+          --is-pre-release "${IS_PRE_RELEASE}" \
 
         if [[ ! -z "${{ inputs.artefact_type }}" ]]; then
           nix run ${{ github.action_path }} -- \
@@ -140,3 +179,8 @@ 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,7 +18,6 @@
           toml
           requests
           pyyaml
-          packaging
         ]);
 
         pythonPackage = pkgs.python3Packages.buildPythonPackage {
@@ -45,7 +44,6 @@
                 requests
                 pythonPackage
                 pyyaml
-                packaging
               ];
             }
             (builtins.readFile ./src/main.py)

justfile

@@ -24,11 +24,4 @@ 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
-
-  # TODO
   # --image "europe-docker.pkg.dev/puzzle-and-play/docker/action-runner-job:latest" \

release/action.yaml

@@ -7,33 +7,9 @@ inputs:
     description: "do not change external state"
     default: false
 
-  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: publish artefacts
       run: |
         nix run ${{ github.action_path }} -- \

src/main.py

@@ -2,8 +2,6 @@ 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
@@ -237,6 +235,7 @@ 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',
@@ -263,7 +262,7 @@ if __name__ == '__main__':
         else:
             raise Exception('flag can be "0" or "1". got: %s' % val)
 
-    parser.add_argument('--state', type=nullable_string)
+    parser.add_argument('--state', required=True)
     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)
@@ -297,8 +296,6 @@ 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('//'):
@@ -307,22 +304,13 @@ if __name__ == '__main__':
             return name
 
     if args.action == 'declare':
-        if args.version_descriptor is None:
+        if args.release_yaml_filename is None:
+            project_description = make_project_description(
+                args.version_descriptor)
+        else:
             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,
@@ -332,12 +320,12 @@ if __name__ == '__main__':
                     args.release_ref_name,
                     args.release_run_number,
                     args.release_commit_sha,
-                    is_pre_release))
+                    args.is_pre_release))
 
-        save_project_description(state_file, project_description)
+        save_project_description(args.state, project_description)
 
     elif args.action == 'add-artefact':
-        project_description = load_project_description(state_file)
+        project_description = load_project_description(args.state)
 
         artefact = make_artefact(args.artefact_type,
                                  args.artefact_repository,
@@ -352,10 +340,10 @@ if __name__ == '__main__':
             project_description,
             artefacts=project_description.artefacts + [artefact])
 
-        save_project_description(state_file, project_description)
+        save_project_description(args.state, project_description)
 
     elif args.action == 'add-deployment':
-        project_description = load_project_description(state_file)
+        project_description = load_project_description(args.state)
 
         deployment = make_deployment(args.deployment_type,
                                      args.deployment_release_name,
@@ -368,42 +356,38 @@ if __name__ == '__main__':
             project_description,
             deployments=project_description.deployments + [deployment])
 
-        save_project_description(state_file, project_description)
+        save_project_description(args.state, project_description)
 
     elif args.action == 'publish-artefacts':
-        project_description = load_project_description(state_file)
+        project_description = load_project_description(args.state)
         publish_artefacts(project_description, args.dry_run)
 
     elif args.action == 'update-deployments':
-        project_description = load_project_description(state_file)
+        project_description = load_project_description(args.state)
         update_deployments(project_description, args.dry_run)
 
     elif args.action == 'create-release':
-        project_description = load_project_description(state_file)
+        project_description = load_project_description(args.state)
         create_release(project_description, args.dry_run)
 
     elif args.action == 'dump':
-        project_description = load_project_description(state_file)
+        project_description = load_project_description(args.state)
         dump_project_description(project_description)
 
     elif args.action == 'check':
-        project_description = load_project_description(state_file)
+        project_description = load_project_description(args.state)
 
     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 = {
+        env_vars = project_description.environment_variables
-            '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

@@ -1,12 +0,0 @@
-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,7 +6,6 @@ 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
 
@@ -21,6 +20,11 @@ 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
@@ -114,7 +118,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)
@@ -136,7 +140,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

@@ -63,7 +63,7 @@ def publish_tarball(info: TarballReleaseInfo, cli: Cli):
     cli('curl',
         '--netrc',
         '--fail-with-body',
-        '--upload-file', info.filename,
+        '--upload-file %s' % info.filename,
         '-i',
         '-X', 'PUT',
         '%s/api/packages/puzzleYOU/generic/%s/%s/%s' % (  # TODO owner

src/release/tests/project.py

@@ -293,12 +293,11 @@ class TestProjectDescription(TestCase):
                 img.make_release_info(release_context, release_version))
 
     def test_project_release_info(self):
-        project_0 = ProjectDescription(
+        project_0 = ProjectDescription(version_descriptor='version.txt')
-            version_descriptor='test-assets/version.txt')
         self.assertIsNone(project_0.release_info)
 
         project_pre = ProjectDescription(
-            version_descriptor='test-assets/version.txt',
+            version_descriptor='version.txt',
             context=ReleaseContext(
                 repository_name='resi',
                 ref_name='testing',
@@ -309,16 +308,16 @@ class TestProjectDescription(TestCase):
 
         self.assertEqual(
             ProjectReleaseInfo(
-                gitea_release_title='Version 1.33.7-dev42',
+                gitea_release_title='Version 0.0.1-dev42',
                 gitea_release_description='',
                 gitea_is_prerelease=True,
                 gitea_git_commitish='PROBABLY_BROKEN',
-                git_tags=['v1.33.7-dev42', 'development'],
+                git_tags=['v0.0.1-dev42', 'development'],
             ),
             project_pre.release_info)
 
         project = ProjectDescription(
-            version_descriptor='test-assets/version.txt',
+            version_descriptor='version.txt',
             context=ReleaseContext(
                 repository_name='resi',
                 ref_name='master',
@@ -329,11 +328,11 @@ class TestProjectDescription(TestCase):
 
         self.assertEqual(
             ProjectReleaseInfo(
-                gitea_release_title='Version 1.33.7',
+                gitea_release_title='Version 0.0.1',
                 gitea_release_description='',
                 gitea_is_prerelease=False,
                 gitea_git_commitish='PROBABLY_BROKEN',
-                git_tags=['v1.33.7', 'v1.33', 'v1', 'latest'],
+                git_tags=['v0.0.1', 'v0.0', 'v0', '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, 42)
+    v.version = Version(1, 33, 7)
 
     with NamedTemporaryFile() as tf:
         v.store(tf.name)
         v2 = use_any(tf.name)
-        test.assertEqual(v2.version, Version(1, 33, 7, 42))
+        test.assertEqual(v2.version, Version(1, 33, 7))
 
 
 class TestSetupPy(TestCase):

src/release/versioning.py

@@ -6,8 +6,6 @@ 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?[\'"](.*)[\'"]')
 
@@ -26,13 +24,12 @@ class SetupPy:
 
         self.filename = filename
         self.content = content
-        self.version = python_parse_version(version_string.group(1))
+        self.version = Version.parse(version_string.group(1))
 
     def store(self, destination=None):
         destination = destination or self.filename
         edited = RE_SETUP_PY.sub(
-            'version=\'%s\'' % python_version_str(self.version),
+            'version=\'%s\'' % self.version, self.content)
-            self.content)
 
         with open(destination, 'w') as f:
             f.write(edited)

version.txt

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