build/action.yml at master · pybuilder/build

346 lines (325 loc) · 12.3 KB
name: 'PyBuilder Action'
description: 'PyBuilder Composite GitHub Action'
  icon: zap
  color: blue
  checkout:
    description: 'Do checkout first'
    required: false
    default: 'true'
  install-python:
    description: 'Whether to install Python'
    required: false
    default: 'true'
  homebrew-python:
    description: 'Whether Python should be installed via Homebrew'
    required: false
    default: 'false'
  python-version:
    description: 'Python version to use, if installing'
    required: false
    default: '3.11'
  architecture:
    description: 'Install Python for specific architecture, if installing'
    required: false
    default: x64
  with-venv:
    description: 'Whether to use Virtualenv during a build'
    required: false
    default: 'true'
  install-pyb:
    description: 'Install PyBuilder'
    required: false
    default: 'true'
  pyb-version:
    description: 'PyBuilder version to install'
    required: false
    default: '>=0.12.0'
  pyb-command:
    description: 'Command to run PyBuilder'
    required: false
    default: 'pyb'
  pyb-args:
    description: 'PyBuilder command line arguments'
    required: false
    default: "-E ci -v -X"
  pyb-extra-args:
    description: 'PyBuilder extra command line arguments'
    required: false
    default: ""
  pre-build:
    description: 'Run a script before PyBuilder build'
    required: false
    default: ""
  is-upload:
    description: 'Whether this matrix slot runs the PyBuilder upload task'
    required: false
    default: 'false'
  auto-release:
    description: 'Enable release automation on [release] in commit message'
    required: false
    default: 'true'
  auto-release-version:
    description: 'Strip .dev from version when [release] detected'
    required: false
    default: 'true'
  auto-github-release:
    description: 'Create GitHub Release with tag (upload job only)'
    required: false
    default: 'true'
  auto-bump-dev:
    description: 'Bump to next .dev version after release (upload job only)'
    required: false
    default: 'true'
  release-tag-prefix:
    description: 'Prefix for release tags'
    required: false
    default: 'v'
  release-title-template:
    description: 'GitHub Release title template ({version} placeholder)'
    required: false
    default: 'Release v{version}'
  build-py-path:
    description: 'Path to build.py relative to repo root'
    required: false
    default: 'build.py'
  github-token:
    description: 'Token for git push and gh CLI; override with PAT for protected branches'
    required: false
    default: ${{ github.token }}
  release-app-id:
    description: 'GitHub App ID for generating release tokens that bypass branch protection'
    required: false
    default: ''
  release-app-private-key:
    description: 'GitHub App private key (PEM) for generating release tokens'
    required: false
    default: ''
  is-release:
    description: 'true if [release] was detected in commit message'
    value: ${{ steps.release-detect.outputs.is-release }}
  release-version:
    description: 'The release version, empty if not a release'
    value: ${{ steps.release-commit.outputs.version }}
  using: "composite"
    - name: Configure Python Executable
      shell: bash
      run: |
        PV='${{inputs.python-version}}'
        PV="${PV##pypy-}"
        echo "PYTHON=python${PV%%.*}" >> $GITHUB_ENV
    - name: Checkout
      if: inputs.checkout == 'true'
      uses: actions/checkout@v6
      with:
        persist-credentials: ${{ inputs.release-app-id == '' }}
    - name: Detect Release
      id: release-detect
      shell: bash
      if: inputs.auto-release == 'true' && github.event_name == 'push'
        COMMIT_MSG: ${{ github.event.head_commit.message }}
      run: |
        if [[ "$COMMIT_MSG" =~ \[release[[:space:]]+([0-9][0-9A-Za-z._]*)\] ]]; then
          echo "is-release=true" >> $GITHUB_OUTPUT
          echo "explicit-version=${BASH_REMATCH[1]}" >> $GITHUB_OUTPUT
        elif [[ "$COMMIT_MSG" =~ \[release\] ]]; then
          echo "is-release=true" >> $GITHUB_OUTPUT
    - name: Setup Python
      if: inputs.install-python == 'true' && (runner.os != 'macOS' || inputs.homebrew-python != 'true')
      uses: actions/setup-python@v6
      with:
        python-version: '${{ inputs.python-version }}'
        architecture: '${{ inputs.architecture }}'
    - name: Setup Python with Homebrew
      shell: bash
      if: inputs.install-python == 'true' && runner.os == 'macOS' && inputs.homebrew-python == 'true'
      run: |
        brew update
        brew upgrade --overwrite
        brew uninstall --force --ignore-dependencies 'python@${{ inputs.python-version }}' || true
        brew install --overwrite 'python@${{ inputs.python-version }}'
        echo "/usr/local/opt/python@${{ inputs.python-version }}/Frameworks/Python.framework/Versions/${{ inputs.python-version }}/bin" >> $GITHUB_PATH
        echo "/usr/local/opt/python@${{ inputs.python-version }}/libexec/bin" >> $GITHUB_PATH
        echo "/usr/local/opt/python@${{ inputs.python-version }}/bin" >> $GITHUB_PATH
        brew cleanup
    - name: Python Pre-VENV Check
      shell: bash
      run: |
        pwd
        echo $PATH
        which $PYTHON
        $PYTHON --version
        $PYTHON -m pip --version
        # $PYTHON -c "import sysconfig; import pprint; pprint.pprint(sysconfig.get_config_vars())"
    - name: Create VEnv
      shell: bash
      if: inputs.with-venv == 'true'
      run: |
        $PYTHON -m pip install --break-system-packages virtualenv
        virtualenv $HOME/.pyb
        echo "$HOME/.pyb/bin" >> $GITHUB_PATH
    - name: Python Post-VENV Check
      shell: bash
      run: |
        pwd
        echo $PATH
        which $PYTHON
        $PYTHON --version
        $PYTHON -m pip --version
        # $PYTHON -c "import sysconfig; import pprint; pprint.pprint(sysconfig.get_config_vars())"
    - name: Install PyBuilder
      shell: bash
      if: inputs.install-pyb == 'true'
      run: |
        $PYTHON -m pip install --break-system-packages 'pybuilder${{ inputs.pyb-version }}'
        which pyb
        pyb --version
    - name: Configure Upload
      shell: bash
      if: inputs.is-upload == 'true'
      run: |
        if [ "$IS_RELEASE" = "true" ]; then
          if [[ "$PYB_EXTRA_ARGS" =~ (^|[[:space:]])\+?upload($|[[:space:]]) ]]; then
            echo "ERROR: pyb-extra-args contains 'upload' or '+upload' but [release] mode is active."
            echo "Remove the upload task from pyb-extra-args and use is-upload instead."
            exit 1
        echo "PYB_UPLOAD=+upload" >> $GITHUB_ENV
        IS_RELEASE: ${{ steps.release-detect.outputs.is-release }}
        PYB_EXTRA_ARGS: ${{ inputs.pyb-extra-args }}
    - name: Set Release Version
      id: release-version
      shell: bash
      if: >-
        steps.release-detect.outputs.is-release == 'true' &&
        inputs.auto-release-version == 'true'
      run: |
        TOOL_PATH="${GITHUB_ACTION_PATH}/version_tool.py"
        EXPLICIT="${{ steps.release-detect.outputs.explicit-version }}"
        if [ -n "$EXPLICIT" ]; then
          $PYTHON "$TOOL_PATH" set-release "${{ inputs.build-py-path }}" "$EXPLICIT"
        else
          $PYTHON "$TOOL_PATH" set-release "${{ inputs.build-py-path }}"
        VERSION_JSON=$($PYTHON "$TOOL_PATH" read "${{ inputs.build-py-path }}")
        VERSION=$(echo "$VERSION_JSON" | $PYTHON -c "import sys,json; print(json.load(sys.stdin)['version'])")
        echo "version=$VERSION" >> $GITHUB_OUTPUT
    - name: Pre-Build
      shell: bash
      if: inputs.pre-build != ''
      run: |
        ${{ inputs.pre-build }}
    - name: Build
      shell: bash
      run: ${{ inputs.pyb-command }} ${{ inputs.pyb-args }} ${{ inputs.pyb-extra-args }} $PYB_UPLOAD
    - name: Generate Release Token
      id: release-token
      if: >-
        inputs.is-upload == 'true' &&
        steps.release-detect.outputs.is-release == 'true' &&
        inputs.release-app-id != '' &&
        inputs.release-app-private-key != ''
      uses: actions/create-github-app-token@v2
      with:
        app-id: ${{ inputs.release-app-id }}
        private-key: ${{ inputs.release-app-private-key }}
    - name: Release Commit and Tag
      id: release-commit
      shell: bash
      if: >-
        inputs.is-upload == 'true' &&
        steps.release-detect.outputs.is-release == 'true'
      run: |
        TOOL_PATH="${GITHUB_ACTION_PATH}/version_tool.py"
        DEFAULT_BRANCH="${{ github.ref_name }}"
        VERSION="${{ steps.release-version.outputs.version }}"
        if [ -z "$VERSION" ]; then
          VERSION_JSON=$($PYTHON "$TOOL_PATH" read "${{ inputs.build-py-path }}")
          VERSION=$(echo "$VERSION_JSON" | $PYTHON -c "import sys,json; print(json.load(sys.stdin)['version'])")
        TAG="${{ inputs.release-tag-prefix }}${VERSION}"
        git config user.name "github-actions[bot]"
        git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
        # Remove checkout's credential helper so the app token in the URL is used
        git config --unset-all http.https://github.com/.extraheader || true
        git remote set-url origin "https://x-access-token:${GH_TOKEN}@github.com/${{ github.repository }}.git"
        # Unshallow if needed — shallow clones can cause push failures
        if [ -f "$(git rev-parse --git-dir)/shallow" ]; then
          git fetch --unshallow origin
        HAVE_RELEASE_COMMIT=false
        if ! git diff --quiet "${{ inputs.build-py-path }}" 2>/dev/null; then
          git add "${{ inputs.build-py-path }}"
          git commit -m "Release version ${VERSION} [skip ci]"
          HAVE_RELEASE_COMMIT=true
        git tag "$TAG"
        PUSH_REFS=("refs/tags/${TAG}")
        if [ "$HAVE_RELEASE_COMMIT" = "true" ]; then
          PUSH_REFS+=("HEAD:refs/heads/${DEFAULT_BRANCH}")
        PUSH_STDERR=$(mktemp)
        if git push --atomic origin "${PUSH_REFS[@]}" 2>"$PUSH_STDERR"; then
          echo "is-coordinator=true" >> $GITHUB_OUTPUT
          echo "tag=${TAG}" >> $GITHUB_OUTPUT
          echo "version=${VERSION}" >> $GITHUB_OUTPUT
        else
          PUSH_ERR=$(cat "$PUSH_STDERR")
          rm -f "$PUSH_STDERR"
          # Check if this is a tag collision (another matrix job already pushed)
          if git ls-remote --tags origin "$TAG" | grep -q "$TAG"; then
            echo "Tag ${TAG} already exists on remote — another job is handling the release"
            echo "is-coordinator=false" >> $GITHUB_OUTPUT
            if [ "$HAVE_RELEASE_COMMIT" = "true" ]; then
              git reset --soft HEAD~1
          else
            echo "::error::git push --atomic failed for refs: ${PUSH_REFS[*]}"
            echo "::error::git stderr: ${PUSH_ERR}"
            exit 1
        rm -f "$PUSH_STDERR"
        GH_TOKEN: ${{ steps.release-token.outputs.token || inputs.github-token }}
    - name: Create GitHub Release
      shell: bash
      if: >-
        steps.release-commit.outputs.is-coordinator == 'true' &&
        inputs.auto-github-release == 'true'
      run: |
        VERSION="${{ steps.release-commit.outputs.version }}"
        TAG="${{ steps.release-commit.outputs.tag }}"
        TITLE="${{ inputs.release-title-template }}"
        TITLE="${TITLE//\{version\}/$VERSION}"
        gh release create "$TAG" \
          --verify-tag \
          --title "$TITLE" \
          --generate-notes
        GH_TOKEN: ${{ steps.release-token.outputs.token || inputs.github-token }}
    - name: Bump Dev Version
      shell: bash
      if: >-
        steps.release-commit.outputs.is-coordinator == 'true' &&
        inputs.auto-bump-dev == 'true'
      run: |
        TOOL_PATH="${GITHUB_ACTION_PATH}/version_tool.py"
        DEFAULT_BRANCH="${{ github.ref_name }}"
        $PYTHON "$TOOL_PATH" bump-dev "${{ inputs.build-py-path }}"
        VERSION_JSON=$($PYTHON "$TOOL_PATH" read "${{ inputs.build-py-path }}")
        NEW_VERSION=$(echo "$VERSION_JSON" | $PYTHON -c "import sys,json; print(json.load(sys.stdin)['version'])")
        git add "${{ inputs.build-py-path }}"
        git commit -m "Bump version to ${NEW_VERSION} [skip ci]"
        git pull --rebase origin "${DEFAULT_BRANCH}"
        git push origin "HEAD:refs/heads/${DEFAULT_BRANCH}"
        GH_TOKEN: ${{ steps.release-token.outputs.token || inputs.github-token }}
Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

action.yml

Latest commit

History

action.yml

File metadata and controls
