.github/workflows/release-proposal.yml - main - niceSOFT/python3-setuptools_scm

.github/workflows/release-proposal.yml
238 строк9 KB
dependabot[bot]
chore(deps): Bump the github-actions group across 1 directory with 5 updates
24 июл 2026, 21:22
24 июл 2026, 21:223a9a8fb
name: Create Release Proposal

on:
  push:
    branches:
      - main
      - develop
  pull_request:

permissions: {}

jobs:
  # Version determination + changelog build for each project (parallel)
  # Forks: run on pull_request only (validation). Intentionally skip fork pushes; do not act on fork release branches/PRs.
  setuptools-scm:
    if: github.repository == 'pypa/setuptools-scm' || github.event_name == 'pull_request'
    uses: ./.github/workflows/reusable-towncrier-release.yml
    with:
      project_name: setuptools-scm
      project_directory: setuptools-scm

  vcs-versioning:
    if: github.repository == 'pypa/setuptools-scm' || github.event_name == 'pull_request'
    uses: ./.github/workflows/reusable-towncrier-release.yml
    with:
      project_name: vcs-versioning
      project_directory: vcs-versioning

  # On PRs: show what would be released
  validate:
    needs: [setuptools-scm, vcs-versioning]
    if: github.event_name == 'pull_request'
    runs-on: ubuntu-latest
    permissions: {}
    steps:
      - name: Release validation summary
        env:
          SCM_FRAGMENTS: ${{ needs.setuptools-scm.outputs.has_fragments }}
          SCM_VERSION: ${{ needs.setuptools-scm.outputs.version }}
          VCS_FRAGMENTS: ${{ needs.vcs-versioning.outputs.has_fragments }}
          VCS_VERSION: ${{ needs.vcs-versioning.outputs.version }}
        run: |
          {
            echo "## Release Proposal Validation"
            echo ""
            if [ "$SCM_FRAGMENTS" == "true" ]; then
              echo "- **setuptools-scm**: v${SCM_VERSION}"
            else
              echo "- **setuptools-scm**: no fragments"
            fi
            if [ "$VCS_FRAGMENTS" == "true" ]; then
              echo "- **vcs-versioning**: v${VCS_VERSION}"
            else
              echo "- **vcs-versioning**: no fragments"
            fi
          } >> "$GITHUB_STEP_SUMMARY"

  # On push: download built changelogs, commit to release branch, create/update PR
  create-release-pr:
    needs: [setuptools-scm, vcs-versioning]
    if: |
      github.repository == 'pypa/setuptools-scm' &&
      github.event_name == 'push' &&
      (needs.setuptools-scm.outputs.has_fragments == 'true' ||
       needs.vcs-versioning.outputs.has_fragments == 'true')
    runs-on: ubuntu-latest
    permissions:
      contents: write
      pull-requests: write
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          fetch-depth: 0

      # Remove only fragment files and CHANGELOG.md; preserve .gitkeep, template.md, README.md
      - name: Prepare for artifact overlay
        env:
          SCM_FRAGMENTS: ${{ needs.setuptools-scm.outputs.has_fragments }}
          VCS_FRAGMENTS: ${{ needs.vcs-versioning.outputs.has_fragments }}
        run: |
          if [ "$SCM_FRAGMENTS" == "true" ]; then
            find setuptools-scm/changelog.d -name "*.*.md" ! -name "template.md" ! -name "README.md" -delete 2>/dev/null || true
            rm -f setuptools-scm/CHANGELOG.md
          fi
          if [ "$VCS_FRAGMENTS" == "true" ]; then
            find vcs-versioning/changelog.d -name "*.*.md" ! -name "template.md" ! -name "README.md" -delete 2>/dev/null || true
            rm -f vcs-versioning/CHANGELOG.md
          fi

      - name: Download setuptools-scm changelog
        if: needs.setuptools-scm.outputs.has_fragments == 'true'
        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
        with:
          name: changelog-setuptools-scm
          path: setuptools-scm

      - name: Download vcs-versioning changelog
        if: needs.vcs-versioning.outputs.has_fragments == 'true'
        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
        with:
          name: changelog-vcs-versioning
          path: vcs-versioning

      - name: Install uv
        uses: astral-sh/setup-uv@v7

      - name: Regenerate per-package lock files
        run: |
          # Hide workspace root so each member resolves independently
          rm pyproject.toml uv.lock
          (cd vcs-versioning && uv lock)
          (cd setuptools-scm && uv lock)
          git checkout pyproject.toml uv.lock

      - name: Configure git
        run: |
          git config user.name "github-actions[bot]"
          git config user.email "github-actions[bot]@users.noreply.github.com"

      - name: Prepare release metadata
        id: meta
        env:
          SCM_FRAGMENTS: ${{ needs.setuptools-scm.outputs.has_fragments }}
          SCM_VERSION: ${{ needs.setuptools-scm.outputs.version }}
          VCS_FRAGMENTS: ${{ needs.vcs-versioning.outputs.has_fragments }}
          VCS_VERSION: ${{ needs.vcs-versioning.outputs.version }}
          SOURCE_BRANCH: ${{ github.ref_name }}
        run: |
          RELEASES=""
          LABELS=""

          if [ "$SCM_FRAGMENTS" == "true" ]; then
            RELEASES="setuptools-scm v${SCM_VERSION}"
            LABELS="release:setuptools-scm"
          fi

          if [ "$VCS_FRAGMENTS" == "true" ]; then
            VCS="vcs-versioning v${VCS_VERSION}"
            if [ -n "$RELEASES" ]; then
              RELEASES="${RELEASES}, ${VCS}"
              LABELS="${LABELS},release:vcs-versioning"
            else
              RELEASES="$VCS"
              LABELS="release:vcs-versioning"
            fi
          fi

          echo "releases=$RELEASES" >> "$GITHUB_OUTPUT"
          echo "labels=$LABELS" >> "$GITHUB_OUTPUT"
          echo "release_branch=release/${SOURCE_BRANCH}" >> "$GITHUB_OUTPUT"

      - name: Create release branch and push
        run: |
          git checkout -B "${{ steps.meta.outputs.release_branch }}"
          git add -A
          git commit -m "Prepare release: ${{ steps.meta.outputs.releases }}" || echo "No changes to commit"
          git push origin "${{ steps.meta.outputs.release_branch }}" --force

      - name: Create or update PR
        uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0
        env:
          RELEASE_BRANCH: ${{ steps.meta.outputs.release_branch }}
          RELEASES: ${{ steps.meta.outputs.releases }}
          LABELS: ${{ steps.meta.outputs.labels }}
          SOURCE_BRANCH: ${{ github.ref_name }}
        with:
          script: |
            const baseBranch = 'main';
            const releaseBranch = process.env.RELEASE_BRANCH;
            const releases = process.env.RELEASES;
            const labels = process.env.LABELS.split(',').filter(l => l);
            const sourceBranch = process.env.SOURCE_BRANCH;
            const owner = context.repo.owner;
            const repo = context.repo.repo;

            const prTitle = `Release: ${releases}`;
            const prBody = [
              '## Release Proposal',
              '',
              'This PR prepares the following releases:',
              releases,
              '',
              `**Source branch:** ${sourceBranch}`,
              '',
              '### Changes',
              '- Updated CHANGELOG.md with towncrier fragments',
              '- Removed processed fragments from changelog.d/',
              '',
              '### Review Checklist',
              '- [ ] Changelog entries are accurate',
              '- [ ] Version numbers are correct',
              '- [ ] All tests pass',
              '',
              '**Merging this PR will automatically create tags and trigger PyPI uploads.**',
              '**After release, main will be synced back to develop.**'
            ].join('\n');

            // Check for existing release PR
            const { data: pulls } = await github.rest.pulls.list({
              owner, repo, state: 'open', base: baseBranch,
              head: `${owner}:${releaseBranch}`
            });

            if (pulls.length > 0) {
              const prNumber = pulls[0].number;
              console.log(`Updating existing PR #${prNumber}`);
              await github.rest.pulls.update({
                owner, repo, pull_number: prNumber,
                title: prTitle, body: prBody, base: baseBranch
              });
              if (labels.length > 0) {
                await github.rest.issues.addLabels({
                  owner, repo, issue_number: prNumber, labels
                });
              }
            } else {
              console.log(`Creating new PR targeting ${baseBranch}`);
              const { data: pr } = await github.rest.pulls.create({
                owner, repo, title: prTitle, body: prBody,
                head: releaseBranch, base: baseBranch
              });
              console.log(`Created PR #${pr.number}`);
              if (labels.length > 0) {
                await github.rest.issues.addLabels({
                  owner, repo, issue_number: pr.number, labels
                });
              }
            }

      - name: Write summary
        env:
          RELEASES: ${{ steps.meta.outputs.releases }}
        run: |
          {
            echo "## Release Proposal"
            echo ""
            echo "**Releases:** ${RELEASES}"
          } >> "$GITHUB_STEP_SUMMARY"