DEBUG REVERTME

.gitea/release.yaml

@@ -1 +1 @@
-version_descriptor: pyproject.toml
+version_descriptor: setup.py

.gitea/workflows/check-is-not-released.yaml

@@ -1,6 +1,7 @@
 name: check if project is already released
 on:
   - pull_request
+  - push # TODO test
 
 jobs:
   unittest:

.gitea/workflows/check.yaml

@@ -135,7 +135,7 @@ jobs:
       - uses: ./add-artefact
         with:
           type: wheel
-          filename: "test-assets/wheels/*.whl"
+          pattern: "test-assets/wheels/*.whl"
 
       - uses: ./add-artefact
         with:

README.md

@@ -1,196 +1,3 @@
 # release action
-Gitea/Github-Action, die hilft das Veröffentlichen von Projekten zu
-automatisieren.
 
-## Features
+TODO document usage
-  - Laden von Credentials und Einrichten der Runner-Umgebung
-  - Veröffentlichen von Artefakten
-    - Docker Images
-    - Python Pakete (wheel, sdist)
-    - NPM Pakete
-    - Tarballs
-  - Ausrollen von Helm-Releases
-  - Anlegen von Gitea-Releases
-  - Anlegen von Git-Tags
-
-## Verwendung
-Die Action erwartet eine Beschreibung des zu veröffentlichenden Projekts in
-`.gitea/release.yaml`. Darin werden folgende Eigenschaften beschrieben:
- - Welche Datei legt die aktuelle Version fest?
- - Welche Artefakte sollen veröffentlicht werden?
- - Welche Releases sollen wann aktualisiert werden?
-
-### Beispiel für release.yaml
-```yaml
-# Die Version wird in der Datei Cargo.toml im Hauptverzeichnis des Projekts festgelegt
-version_descriptor: Cargo.toml
-
-artefacts:
-  # Es soll ein Docker/OCI-Image mit dem Namen masa-images veröffentlicht werden
-  - type: oci_image
-    name: masa-images
-
-  # Es soll ein Python-Paket als Wheel veröffentlicht werden
-  - type: wheel
-    # Unter diesem Pfad ist das Wheel abgelegt (vor dem Upload in die Registry)
-    filename: ./scratch/wheels/*.whl
-    # Diese Datei bestimmt die Version des Pakets.
-    # Wird synchronisiert mit der Version des Projekts.
-    version_descriptor: pyproject.toml
-
-deployments:
-  # Bei einem Prerelease (push in testing) soll das Helm-Release masa-images-testing
-  # aktualisiert werden.
-  - type: helm
-    release_name: masa-images-testing
-```
-
-Alle möglichen Einstellungen können
-[hier](/src/release/tests/assets/release.yaml) eingesehen werden.
-
-### Aufruf im Workflow
-Die Action kann die generischen Aufgaben bei einem Release übernehmen. Was sie
-nicht kann ist die Artefakte bauen. Wie das zu tun ist muss das Projekt selbst
-beschreiben.
-
-Dafür gibt es zwei Möglichkeiten: Die Kurzform in einem Schritt und die
-Langform in mehreren Schritten.
-
-#### Langform
-Wenn ein Projekt veröffentlicht wird, dann werden folgende Schritt ausgeführt:
-- `actions/release/declare`: Hier wird die `release.yaml` gelesen und die
-  Credentials werden geladen.
-- `actions/release/sync-versions`: Hier werden die Versionen der Artefakte mit
-  der Version des Projekts synchronisiert.
-- Hier muss das Projekt die Artefakte bauen.
-- `actions/release/release`: Hier werden die Artefakte veröffentlicht, das
-  Helm-Release aktualisiert und das Gitea-Release angelegt.
-
-Beispiel:
-```yaml
-name: release
-on:
-  push:
-    branches:
-      - master
-      - testing
-
-jobs:
-  check:
-    uses: ./.gitea/workflows/checks.yaml
-
-  release:
-    needs: ["check"]
-    runs-on: action-runner
-    env:
-      RUSTC_WRAPPER: sccache
-    steps:
-      - uses: actions/checkout@v4
-      - uses: https://gitea.puzzleyou.net/actions/release/declare@v0
-      - uses: https://gitea.puzzleyou.net/actions/release/sync-versions@v0
-
-      - name: build image
-        run: |
-          nix develop --command just build-image ${RELEASE_IMAGE_TAG}
-          sccache --show-stats
-
-      - name: build wheel
-        run: |
-          mkdir -p ./scratch/wheels
-          nix develop --command \
-            maturin build \
-              --release \
-              --out ./scratch/wheels/ \
-              --strip \
-              -m Cargo.toml \
-              --compatibility linux \
-              --interpreter python3.13
-          sccache --show-stats
-
-      - uses: https://gitea.puzzleyou.net/actions/release@v0
-```
-
-#### Kurzform
-Wenn es nur ein Artefakt gibt und das auch einfach zu bauen ist, dann kann die
-Kurzform `actions/release` verwendet werden. Das ist der Normalfall. Im
-Parameter `build_run` muss das Projekt (in Form eines Bash-Scripts) beschreiben
-wie die Artefakte gebaut werden.
-
-Beispiel:
-```yaml
-name: release
-on:
-  push:
-    branches:
-      - master
-      - testing
-
-jobs:
-  release:
-    runs-on: action-runner
-    steps:
-      - uses: actions/checkout@v4
-      - uses: https://gitea.puzzleyou.net/actions/release@v0
-        with:
-          build_run: docker build -t "${RELEASE_IMAGE_LOCAL_NAME_ALI}" .
-```
-
-## Umgebungsvariablen
-Die Action stellt einige Umgebungsvariablen bereit, die im Workflow nützlich
-sein können:
-- `RELEASE_IMAGE_TAG`: Tag, der Docker/OCI-Images zugewiesen werden muss, damit
-  diese veröffentlicht und in Helm-Releases verwendet werden können. Entspricht
-  momentan dem Commit-Hash.
-- `RELEASE_IMAGE_LOCAL_NAME_XXX`: Voller Name eines Docker/OCI-Images mit Tag.
-- `RELEASE_IS_PRERELEASE`: Wird gerade ein Release (master/main) oder ein
-  Prerelease (testing) verarbeitet?
-- `RELEASE_PROJECT_IS_RELEASED`: Wurde das Projekt schon unter dieser Version
-  veröffentlicht?
-- `RELEASE_PROJECT_CURRENT_VERSION`: Aktuelle Version des Projekts, z.B.
-  '2.10.4'
-- `RELEASE_PROJECT_PLANNED_VERSION`: "Geplante" Version des Projekts.
-  Entspricht der aktuellen Version mit optionalem Suffix bei Prerelease, z.B.
-  '2.10.4-dev42'
-
-## Release vs. Prerelease
-Die Release-Action kann für Releases (merge in master/main) oder Prereleases
-(merge in testing) verwendet werden.
-
-Es unterscheiden sich dann image-tags, git-tags und Versionsnummern der
-Artefakte.
-
-### Release
-- Image-Tags: `v1`, `v1.2`, `v1.2.3`, `latest`, `master/main.latest`
-- Git-Tags: `v1`, `v1.2`, `v1.2.3`, `latest`
-- Versionsummern: Wie Projekt
-
-### Prerelease
-- Image-Tags: `v1.2.3-dev4`, `development`, `testing.latest`
-- Git-Tags: `v1.2.3-dev4`, `development`
-- Versionsnummern: Wie Projekt, mit Suffix `-dev$ACTION_LAUF_NUMMER`
-
-## Prüfung ob eine Version schon veröffentlicht wurde
-Beim Release selbst (merge in main/master) wird geprüft ob eine Version bereits
-veröffentlicht wurde. Falls ja, ist das kein Fehler. **ABER** es wird in dem
-Fall weder ein Docker/OCI-Image hochgeladen, noch ein Helm-Release aktualisiert
-oder irgendwelche anderen Artefakte veröffentlicht. Das kann erwünscht sein,
-wenn eine Änderung nicht ausgerollt werden muss (z.b. Dokumentation angepasst,
-fixtures verändert, etc.)
-
-Um bei einem Pull-Request eine Warnung zu sehen, wenn die Version nicht erhöht
-wurde kann folgender Workflow verwendet werden. Es ist keine Anpassung nötig.
-```yaml
-name: check if project is already released
-on:
-  - pull_request
-
-jobs:
-  check:
-    runs-on: action-runner
-    steps:
-      - uses: actions/checkout@v4
-      - uses: https://gitea.puzzleyou.net/actions/release/check-is-not-released@v0
-```
-
-Bei einem Prerelease (merge in testing) muss die Version nicht angepasst
-werden. Das geschieht automatisch.

add-artefact/action.yaml

@@ -18,7 +18,7 @@ inputs:
 
   filename:
     required: false
-    description: "required for tarball, sdist, wheel"
+    description: "required for tarball, sdist"
     default: ""
 
   package_name:
@@ -26,6 +26,11 @@ inputs:
     description: "required for tarball"
     default: ""
 
+  pattern:
+    required: false
+    description: "required for wheel"
+    default: ""
+
   directory:
     required: false
     description: "required for npm"
@@ -49,6 +54,7 @@ runs:
           --artefact-name "${{ inputs.name }}" \
           --artefact-filename "${{ inputs.filename }}" \
           --artefact-package-name "${{ inputs.package_name }}" \
+          --artefact-pattern "${{ inputs.pattern }}" \
           --artefact-directory "${{ inputs.directory }}" \
           --version-descriptor "${{ inputs.version_descriptor }}" \
           --write-env-vars-to-filename "$GITHUB_ENV"

declare/action.yaml

@@ -41,7 +41,7 @@ inputs:
 
   artefact_filename:
     required: false
-    description: "required for tarball, sdist, wheel"
+    description: "required for tarball, sdist"
     default: ""
 
   artefact_package_name:
@@ -49,6 +49,11 @@ inputs:
     description: "required for tarball"
     default: ""
 
+  artefact_pattern:
+    required: false
+    description: "required for wheel"
+    default: ""
+
   artefact_directory:
     required: false
     description: "required for npm"
@@ -124,6 +129,7 @@ runs:
             --artefact-name "${{ inputs.artefact_name }}" \
             --artefact-filename "${{ inputs.artefact_filename }}" \
             --artefact-package-name "${{ inputs.artefact_package_name }}" \
+            --artefact-pattern "${{ inputs.artefact_pattern }}" \
             --artefact-directory "${{ inputs.artefact_directory }}" \
             --version-descriptor "${{ inputs.artefact_version_descriptor }}"
         fi

dump/action.yaml

@@ -4,23 +4,6 @@ description: "dump current project description"
 runs:
   using: composite
   steps:
-    - 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: dump project description
       run: |
         nix run ${{ github.action_path }} -- \

flake.lock

@@ -34,31 +34,10 @@
         "type": "github"
       }
     },
-    "pyproject-nix": {
-      "inputs": {
-        "nixpkgs": [
-          "nixpkgs"
-        ]
-      },
-      "locked": {
-        "lastModified": 1764134915,
-        "narHash": "sha256-xaKvtPx6YAnA3HQVp5LwyYG1MaN4LLehpQI8xEdBvBY=",
-        "owner": "pyproject-nix",
-        "repo": "pyproject.nix",
-        "rev": "2c8df1383b32e5443c921f61224b198a2282a657",
-        "type": "github"
-      },
-      "original": {
-        "owner": "pyproject-nix",
-        "repo": "pyproject.nix",
-        "type": "github"
-      }
-    },
     "root": {
       "inputs": {
         "flake-utils": "flake-utils",
-        "nixpkgs": "nixpkgs",
+        "nixpkgs": "nixpkgs"
-        "pyproject-nix": "pyproject-nix"
       }
     },
     "systems": {

flake.nix

@@ -4,41 +4,52 @@
   inputs = {
     nixpkgs.url = "github:NixOS/nixpkgs/nixos-25.05";
     flake-utils.url = "github:numtide/flake-utils";
-
-    pyproject-nix = {
-      url = "github:pyproject-nix/pyproject.nix";
-      inputs.nixpkgs.follows = "nixpkgs";
-    };
   };
 
-  outputs = { self, nixpkgs, flake-utils, pyproject-nix }:
+  outputs = { self, nixpkgs, flake-utils, ... }:
     flake-utils.lib.eachDefaultSystem (system:
       let
         pkgs = import nixpkgs { inherit system; };
 
-        pythonProject = pyproject-nix.lib.project.loadPyproject {
+        python = pkgs.python313.withPackages (ps: with ps; [
-          projectRoot = ./.;
+          isort
-        };
+          flake8
+          semver
+          toml
+          requests
+          pyyaml
+          packaging
+        ]);
 
-        pythonInterpreter = pkgs.python313;
+        pythonPackage = pkgs.python3Packages.buildPythonPackage {
+          name = "release-action";
+          src = ./.;
+        };
       in
         {
           devShells.default = pkgs.mkShell {
             buildInputs = [
+              pkgs.envsubst
               pkgs.just
               pkgs.gitea-actions-runner
-              (pythonInterpreter.withPackages
+              python
-                (pythonProject.renderers.withPackages {
-                  python = pythonInterpreter;
-                  extraPackages = ps: with ps; [ flake8 isort ];
-                }))
             ];
           };
 
-          packages.default = pythonInterpreter.pkgs.buildPythonPackage (
+          packages.default = pkgs.writers.writePython3Bin
-            pythonProject.renderers.buildPythonPackage {
+            "release-action"
-              python = pythonInterpreter;
+            {
-            });
+              libraries = with pkgs.python3Packages; [
+                semver # TODO move to setup.py?
+                toml
+                requests
+                pythonPackage
+                pyyaml
+                packaging
+              ];
+            }
+            (builtins.readFile ./src/main.py)
+          ;
         }
     );
 }

pyproject.toml

@@ -1,16 +0,0 @@
-[project]
-name = "gitea-release-action"
-version = "0.0.1"
-description = "reusable action for release workflows"
-authors = [ ]
-requires-python = ">=3.13"
-dependencies = [
-  "semver",
-  "toml",
-  "requests",
-  "pyyaml",
-  "packaging"
-]
-
-[project.scripts]
-gitea-release-action = "main:main_cli"

setup.py

@@ -0,0 +1,6 @@
+from setuptools import setup
+
+setup(
+    name='release-action',
+    version='0.0.2',
+)

src/main.py

@@ -82,7 +82,7 @@ def dump_project_description(project_description: ProjectDescription):
             print('    release version name: %s' % release_info.version_str)
 
         elif isinstance(generated, Wheel):
-            print('  - wheel: %s' % generated.filename)
+            print('  - wheel: %s' % generated.pattern)
             print('    repository: %s' % generated.repository)
             print('    release version name: %s' % release_info.version_str)
 
@@ -152,6 +152,7 @@ def make_artefact(type: str,
                   name: str,
                   filename: str,
                   package_name: str,
+                  pattern: str,
                   directory: str,
                   version_descriptor) -> ArtefactDescription:
 
@@ -171,8 +172,8 @@ def make_artefact(type: str,
                             **maybe_repository)
 
     elif type == 'wheel':
-        assert filename is not None
+        assert pattern is not None
-        generated = Wheel(filename=filename, **maybe_repository)
+        generated = Wheel(pattern=pattern, **maybe_repository)
 
     elif type == 'sdist':
         assert filename is not None
@@ -247,7 +248,7 @@ def sync_versions(project_description: ProjectDescription):
             sync(artefact.version_descriptor)
 
 
-def main_cli():
+if __name__ == '__main__':
     parser = ArgumentParser()
     parser.add_argument('action', choices=[
         'declare',
@@ -296,6 +297,7 @@ def main_cli():
     parser.add_argument('--artefact-name', type=nullable_string)
     parser.add_argument('--artefact-package-name', type=nullable_string)
     parser.add_argument('--artefact-filename', type=nullable_string)
+    parser.add_argument('--artefact-pattern', type=nullable_string)
     parser.add_argument('--artefact-directory', type=nullable_string)
 
     parser.add_argument('--deployment-type',
@@ -357,6 +359,7 @@ def main_cli():
                                  args.artefact_name,
                                  args.artefact_filename,
                                  args.artefact_package_name,
+                                 args.artefact_pattern,
                                  args.artefact_directory,
                                  args.version_descriptor)
 

src/release/project.py

@@ -97,14 +97,14 @@ class Tarball:
 
 @dataclass(frozen=True)
 class WheelReleaseInfo:
-    filename: str
+    pattern: str
     repository: str
     version_str: str
 
 
 @dataclass(frozen=True)
 class Wheel:
-    filename: str
+    pattern: str
     repository: str = DEFAULT_PYPI_REPOSITORY_NAME
 
     def make_environment_variables(self, context, version):
@@ -112,7 +112,7 @@ class Wheel:
 
     def make_release_info(self, context: ReleaseContext, version: Version):
         return WheelReleaseInfo(
-            filename=self.filename,
+            pattern=self.pattern,
             repository=self.repository,
             version_str=python_version_str(version))
 
@@ -327,8 +327,8 @@ def parse_project_description(obj):
                        **optional(tar, 'repository'))
 
     def parse_wheel(whl):
-        assert 'filename' in whl
+        assert 'pattern' in whl
-        return Wheel(filename=whl['filename'],
+        return Wheel(pattern=whl['pattern'],
                      **optional(whl, 'repository'))
 
     def parse_sdist(sdist):

src/release/release.py

@@ -84,7 +84,7 @@ def publish_wheel(info: WheelReleaseInfo, cli: Cli):
         'upload',
         '--verbose',
         '--repository', info.repository,
-        info.filename)
+        info.pattern)
     print()
 
 

src/release/tests/assets/release.yaml

@@ -19,10 +19,10 @@ artefacts:
     repository: balls
 
   - type: wheel
-    filename: './scratch/wheels/*.whl'
+    pattern: './scratch/wheels/*.whl'
 
   - type: wheel
-    filename: './scratch/wheels/*.whl'
+    pattern: './scratch/wheels/*.whl'
     repository: other
 
   - type: sdist

src/release/tests/project.py

@@ -30,7 +30,7 @@ class TestProjectDescription(TestCase):
             version_descriptor='src/python/Cargo.toml',
             artefacts=[
                 ArtefactDescription(
-                    generated=Wheel(filename='./scratch/wheels/*.whl'))
+                    generated=Wheel(pattern='./scratch/wheels/*.whl'))
             ])
 
         # productdesignerd
@@ -55,7 +55,7 @@ class TestProjectDescription(TestCase):
                 ArtefactDescription(
                     generated=OciImage(name='masa-images')),
                 ArtefactDescription(
-                    generated=Wheel(filename='./scratch/wheels/*.whl'))
+                    generated=Wheel(pattern='./scratch/wheels/*.whl'))
             ],
             deployments=[
                 DeploymentDescription(
@@ -134,7 +134,7 @@ class TestProjectDescription(TestCase):
             artefacts=[
                 ArtefactDescription(
                     version_descriptor='src/python/pyproject.toml',
-                    generated=Wheel(filename='./scratch/wheels/*.whl')),
+                    generated=Wheel(pattern='./scratch/wheels/*.whl')),
                 ArtefactDescription(generated=OciImage(name='prngl')),
             ],
             deployments=[
@@ -211,9 +211,9 @@ class TestProjectDescription(TestCase):
             tarball.make_release_info(None, Version(1, 2, 3, 'dev4')))
 
     def test_wheel_release_info(self):
-        wheel = Wheel(filename='dist/wheels/*')
+        wheel = Wheel(pattern='dist/wheels/*')
         self.assertEqual(
-            WheelReleaseInfo(filename='dist/wheels/*',
+            WheelReleaseInfo(pattern='dist/wheels/*',
                              repository='gitea',
                              version_str='1.2.3.dev4'),
             wheel.make_release_info(None, Version(1, 2, 3, 'dev4')))
@@ -366,9 +366,9 @@ class TestProjectDescription(TestCase):
                     repository='balls')),
 
                 ArtefactDescription(generated=Wheel(
-                    filename='./scratch/wheels/*.whl')),
+                    pattern='./scratch/wheels/*.whl')),
                 ArtefactDescription(generated=Wheel(
-                    filename='./scratch/wheels/*.whl', repository='other')),
+                    pattern='./scratch/wheels/*.whl', repository='other')),
 
                 ArtefactDescription(generated=Sdist(
                     filename='./dist/papyru-0.0.1.tar.gz')),

sync-versions/action.yaml

@@ -6,23 +6,6 @@ inputs: {}
 runs:
   using: composite
   steps:
-    - 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: sync versions
       run: |
         nix run ${{ github.action_path }} -- \