add workflow to release and tag collection

abikouo · web-flow · commit b3e184511176 · 2023-05-22T15:05:21.000+02:00
workflow to release collection
diff --git a/.github/workflows/release-branch.yml b/.github/workflows/release-branch.yml
@@ -0,0 +1,84 @@
+name: Release
+
+on:
+  workflow_call:
+    inputs:
+      release_branch:
+        description: The release base branch
+        required: true
+        type: string
+
+jobs:
+  release:
+    env:
+      source_path: "./source"
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+
+    steps:
+      - name: setup python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.9"
+
+      - name: Install python required libraries
+        run: pip install -U pygithub semver tox pyyaml
+        shell: bash
+
+      - name: Download python script
+        run: >-
+          curl -o create_release_branch.py
+          https://raw.githubusercontent.com/abikouo/github_actions/release_v2/scripts/create_release_branch.py
+
+      - name: Compute release version and create release branch
+        id: compute-version
+        run: >-
+          python3 ./create_release_branch.py
+        env:
+          REPOSITORY_NAME: ${{ github.repository }}
+          RELEASE_BRANCH: ${{ inputs.release_branch }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Checkout the repository
+        uses: actions/checkout@v3
+        with:
+          path: ${{ env.source_path }}
+          fetch-depth: "0"
+        if: ${{ (steps.compute-version.outputs.release_version != '') }}
+
+      - name: Prepare release
+        run: tox -e prepare_release -vv
+        shell: bash
+        working-directory: ${{ env.source_path }}
+        env:
+          RELEASE_VERSION: ${{ steps.compute-version.outputs.release_version }}
+        if: ${{ (steps.compute-version.outputs.release_version != '') }}
+
+      - name: Download python script used to update galaxy file
+        run: >-
+          curl -o update_galaxy_file.py
+          https://raw.githubusercontent.com/abikouo/github_actions/release_v2/scripts/update_galaxy_file.py
+        if: ${{ (steps.compute-version.outputs.release_version != '') }}
+
+      - name: Compute release version and create release branch
+        run: >-
+          python3 ./update_galaxy_file.py
+        env:
+          COLLECTION_PATH: ${{ env.source_path }}
+          RELEASE_VERSION: ${{ steps.compute-version.outputs.release_version }}
+        if: ${{ (steps.compute-version.outputs.release_version != '') }}
+
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v5
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          path: ${{ env.source_path }}
+          commit-message: "Release ${{ steps.compute-version.outputs.release_version }}"
+          base: ${{ inputs.release_branch }}
+          branch: "prepare_release_${{ steps.compute-version.outputs.release_version }}"
+          title: "Prepare release ${{ steps.compute-version.outputs.release_version }}"
+          body: |
+            Release ${{ steps.compute-version.outputs.release_version }}
+        if: ${{ (steps.compute-version.outputs.release_version != '') }}
diff --git a/.github/workflows/release-tag.yml b/.github/workflows/release-tag.yml
@@ -0,0 +1,70 @@
+name: tagging
+
+on:
+  workflow_call:
+    inputs:
+      branch_name:
+        description: The branch name to create tag from.
+        type: string
+        default: ${{ github.base_ref }}
+      release_publish:
+        default: true
+        description: Publish a new github release.
+        type: boolean
+      release_prefix:
+        default: "Release"
+        description: Prefix name of the release to create.
+        type: string
+    secrets:
+      # due to https://github.com/ad-m/github-push-action/issues/32 we are not using default GITHUB_TOKEN
+      gh_token:
+        required: true
+
+jobs:
+  push:
+    if: "github.event.pull_request.merged == true"
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ inputs.branch_name }}
+          token: ${{ secrets.gh_token }}
+        if: "contains(github.event.pull_request.labels.*.name, 'ok-to-tag')"
+
+      - name: setup python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.9"
+        if: "contains(github.event.pull_request.labels.*.name, 'ok-to-tag')"
+
+      - name: install python libraries
+        run: pip3 install yq pygithub
+        shell: bash
+        if: "contains(github.event.pull_request.labels.*.name, 'ok-to-tag')"
+
+      - name: extract tag name from 'galaxy.yml'
+        id: read-tag
+        run: echo "release_tag=$(yq -r '.version' 'galaxy.yml')" >> $GITHUB_OUTPUT
+        shell: bash
+        if: "contains(github.event.pull_request.labels.*.name, 'ok-to-tag')"
+
+      - name: create tag
+        run: |
+          curl -o create_github_tag.py https://raw.githubusercontent.com/abikouo/github_actions/release_v2/scripts/create_github_tag.py
+          python3 ./create_github_tag.py --repository ${{ github.repository }} --tag ${{ steps.read-tag.outputs.release_tag }} --branch ${{ inputs.branch_name }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.gh_token }}
+        if: "contains(github.event.pull_request.labels.*.name, 'ok-to-tag')"
+
+      - name: Parse release content
+        run: |
+          curl -o create_github_release.py https://raw.githubusercontent.com/abikouo/github_actions/release_v2/scripts/create_github_release.py
+          python3 ./create_github_release.py --repository ${{ github.repository }} --release-tag ${{ steps.read-tag.outputs.release_tag }} --release-name "${{ inputs.release_prefix }} ${{ steps.read-tag.outputs.release_tag }}"
+        env:
+          GITHUB_TOKEN: ${{ secrets.gh_token }}
+        if: ${{ (inputs.release_publish) && contains(github.event.pull_request.labels.*.name, 'ok-to-tag') }}
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -74,6 +74,7 @@ repos:
           - PyYAML
           - pygithub
           - pytest
+          - semver
 
   - repo: local
     hooks:
diff --git a/scripts/create_github_release.py b/scripts/create_github_release.py
@@ -0,0 +1,85 @@
+#!/usr/bin/env python3
+"""Script to read release content from CHANGELOG.rst file."""
+
+import logging
+import os
+import re
+
+from argparse import ArgumentParser
+from pathlib import PosixPath
+
+from github import Github
+
+
+FORMAT = "[%(asctime)s] - %(message)s"
+logging.basicConfig(format=FORMAT)
+logger = logging.getLogger(__file__)
+logger.setLevel(logging.DEBUG)
+
+
+def create_git_release(
+    repository: str, release_name: str, release_tag: str, release_content: str
+) -> None:
+    """Create github release on Repository.
+
+    :param repository: Github repository name.
+    :param release_tag: Release tag.
+    :param release_content: Release description.
+    :param release_name: The name of the release to create.
+    """
+    access_token = os.environ.get("GITHUB_TOKEN")
+
+    gh_client = Github(access_token)
+    gh_repository = gh_client.get_repo(repository)
+    gh_repository.create_git_release(release_tag, release_name, release_content)
+
+
+def parse_release_content(release_version: str) -> str:
+    """Parse release content from CHANGELOG.rst.
+
+    :param release_version: Release version to parse content.
+    :returns: The release content found from CHANGELOG.rst
+    """
+    if not PosixPath("CHANGELOG.rst").exists():
+        logger.error("CHANGELOG.rst does not exist.")
+        return "..."
+
+    release_content = "..."
+    with PosixPath("CHANGELOG.rst").open(encoding="utf-8") as file_write:
+        data = file_write.read().splitlines()
+        idx = 0
+        start, end = -1, 0
+        while idx < len(data):
+            if data[idx].startswith(f"v{release_version}") and data[idx + 1] == "======":
+                start = idx + 2
+                idx += 2
+            elif (
+                start > 0
+                and re.match(r"^v[0-9]+\.[0-9]+\.[0-9]+$", data[idx])
+                and data[idx + 1] == "======"
+            ):
+                end = idx
+                break
+            idx += 1
+        if start != -1:
+            release_content = "\n".join(data[start:]) if not end else "\n".join(data[start:end])
+    return release_content
+
+
+def main() -> None:
+    """Read release content from CHANGELOG.rst for a specific version."""
+    parser = ArgumentParser(
+        description="Read release content from CHANGELOG.rst for a specific version."
+    )
+    parser.add_argument("--repository", required=True, help="Repository name.")
+    parser.add_argument("--release-tag", required=True, help="Release tag.")
+    parser.add_argument("--release-name", required=True, help="Name of the release to create.")
+
+    args = parser.parse_args()
+
+    release_content = parse_release_content(args.release_tag)
+    create_git_release(args.repository, args.release_name, args.release_tag, release_content)
+
+
+if __name__ == "__main__":
+    main()
diff --git a/scripts/create_github_tag.py b/scripts/create_github_tag.py
@@ -0,0 +1,52 @@
+#!/usr/bin/env python3
+"""Script to create tag on github repository."""
+
+import logging
+import os
+
+from argparse import ArgumentParser
+
+from github import Github
+
+
+FORMAT = "[%(asctime)s] - %(message)s"
+logging.basicConfig(format=FORMAT)
+logger = logging.getLogger("compute_release_version")
+logger.setLevel(logging.DEBUG)
+
+
+def main() -> None:
+    """Create tag and publish to Github repository."""
+    parser = ArgumentParser(
+        description="Create tag to Github repository and pull request to default branch."
+    )
+    parser.add_argument("--repository", required=True, help="Repository name.")
+    parser.add_argument("--tag", required=True, help="Name of the tag to create.")
+    parser.add_argument("--branch", required=True, help="Name of the branch to create tag from.")
+
+    args = parser.parse_args()
+
+    access_token = os.environ.get("GITHUB_TOKEN")
+
+    gh_instance = Github(access_token)
+    gh_repository = gh_instance.get_repo(args.repository)
+
+    commit_sha = gh_repository.get_branch(args.branch).commit.sha
+    logger.info("Create tag [%s] from commit '%s'", args.tag, commit_sha)
+    gh_repository.create_git_ref(f"refs/tags/{args.tag}", commit_sha)
+
+    # create pull request to default branch
+    if args.branch != gh_repository.default_branch:
+        default_branch = gh_repository.default_branch
+        pr_title = f"Release '{args.tag}' on '{default_branch}'"
+        body = f"Push changes from Release {args.tag} into default repository branch."
+        logger.info(
+            "Create pull request from branch '%s' to default branch '%s'",
+            args.branch,
+            default_branch,
+        )
+        gh_repository.create_pull(title=pr_title, body=body, head=args.branch, base=default_branch)
+
+
+if __name__ == "__main__":
+    main()
diff --git a/scripts/create_release_branch.py b/scripts/create_release_branch.py
@@ -0,0 +1,85 @@
+#!/usr/bin/env python3
+"""Script to compute release version based on release branch."""
+
+import logging
+import os
+
+import semver
+
+from github import Github
+from github import Repository
+
+
+FORMAT = "[%(asctime)s] - %(message)s"
+logging.basicConfig(format=FORMAT)
+logger = logging.getLogger("compute_release_version")
+logger.setLevel(logging.DEBUG)
+
+
+def compute_next_release_version(release_tags: list[str], release_branch: str) -> str:
+    """Bump minor or patch version depending on target branch and existing tags.
+
+    :param release_tags: list of existing tags from github repository
+    :param release_branch: Release base branch
+    :returns: a release version as string
+    """
+    release_version = release_branch.replace("stable-", "") + ".0"
+    myversion = semver.Version.parse(release_version)
+
+    minor_found = False
+    for item in release_tags:
+        version_obj = semver.Version.parse(item)
+        if version_obj.major == myversion.major and version_obj.minor == myversion.minor:
+            minor_found = True
+            if semver.compare(str(myversion), str(version_obj)) == -1:
+                myversion = version_obj
+
+    return str(myversion.bump_patch()) if minor_found else str(myversion)
+
+
+def create_repository_branch(gh_repository: Repository.Repository, release_branch: str) -> None:
+    """Create a branch on github repository.
+
+    :param gh_repository: Github repository object.
+    :param release_branch: Name of the branch to create.
+    """
+    repository_branches = [branch.name for branch in gh_repository.get_branches()]
+    logger.info("Repository branches: %s", repository_branches)
+    if release_branch not in repository_branches:
+        default_branch = gh_repository.default_branch
+        logger.info("Repository default branch: %s", default_branch)
+        default_branch_obj = gh_repository.get_branch(default_branch)
+        logger.info("Creating release branch: %s", release_branch)
+        gh_repository.create_git_ref(
+            ref="refs/heads/" + release_branch, sha=default_branch_obj.commit.sha
+        )
+
+
+def main() -> None:
+    """Read boto constraints and update variables accordingly."""
+    repository = os.environ.get("REPOSITORY_NAME") or ""
+    access_token = os.environ.get("GITHUB_TOKEN")
+    release_branch = os.environ.get("RELEASE_BRANCH", "")
+
+    logger.info("Repository name -> '%s'", repository)
+    logger.info("Github token -> '%s'", access_token)
+    logger.info("Release branch -> '%s'", release_branch)
+
+    gh_client = Github(access_token)
+    gh_repository = gh_client.get_repo(repository)
+
+    if release_branch:
+        repository_tags = [tag.name for tag in gh_repository.get_tags()]
+        logger.info("Repository tags => %s", repository_tags)
+
+        release_version = compute_next_release_version(repository_tags, release_branch)
+        if release_version:
+            create_repository_branch(gh_repository, release_branch)
+            github_output_file = os.environ.get("GITHUB_OUTPUT") or ""
+            if github_output_file:
+                with open(github_output_file, "a", encoding="utf-8") as file_write:
+                    file_write.write(f"release_version={release_version}\n")
+
+
+if __name__ == "__main__":
+    main()
diff --git a/scripts/update_galaxy_file.py b/scripts/update_galaxy_file.py
