frog

.git-blame-ignore-revs

@@ -0,0 +1 @@
+1d7b1abd152e4cb5e6a46e52e6b7e3bf8d366486

.github/CODEOWNERS

@@ -0,0 +1,9 @@
+source/guides/github-actions-ci-cd-sample/* @webknjaz
+source/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows.rst @webknjaz
+
+# Sphinx extension
+pug_sphinx_extensions/ @FFY00
+
+# build-details.json
+source/specifications/build-details/ @FFY00
+source/specifications/specs/build-details-*.json @FFY00

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: "Community Guidelines"
+    url: "https://github.com/pypa/.github/blob/main/CODE_OF_CONDUCT.md"
+    about: "Please make sure to follow the PSF Code of Conduct when participating in this repository."

.github/ISSUE_TEMPLATE/general.yml

@@ -0,0 +1,37 @@
+name: General Issue
+description: Please fill out the form below to submit an issue.
+labels: []
+assignees: []
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        **Thanks for taking a minute to file an issue!**
+
+        Read the [PSF Code of Conduct][CoC] first.
+
+        ⚠
+        Verify first that your issue is not [already reported on
+        GitHub][issue search].
+
+        _Please fill out the form below with as many precise
+        details as possible._
+
+        [CoC]: https://github.com/pypa/.github/blob/main/CODE_OF_CONDUCT.md
+        [issue search]: ../search?q=is%3Aissue&type=issues
+
+  - type: textarea
+    attributes:
+      label: Issue Description
+      description: Please provide a detailed description of your issue.
+      placeholder: Describe your issue here...
+    validations:
+      required: true
+
+  - type: checkboxes
+    attributes:
+      label: Code of Conduct
+      options:
+        - label: I am aware that participants in this repository must follow the PSF Code of Conduct.
+          required: true

.github/sphinx_lint_matcher.json

@@ -0,0 +1,15 @@
+{
+    "problemMatcher": [
+        {
+            "owner": "sphinx-lint-problem-matcher",
+            "pattern": [
+                {
+                    "regexp": "^(.*):(\\d+):\\s+(.*)$",
+                    "file": 1,
+                    "line": 2,
+                    "message": 3
+                }
+            ]
+        }
+    ]
+}

.github/workflows/cron.yml

@@ -0,0 +1,14 @@
+---
+
+name: Cron
+
+on:
+  schedule:
+  - cron: "0 6 * * *"  # daily at 6am
+
+jobs:
+  test:
+    if: github.repository_owner == 'pypa'  # suppress noise in forks
+    uses: ./.github/workflows/test.yml
+
+...

.github/workflows/pr-preview-links.yml

@@ -0,0 +1,22 @@
+name: Read the Docs PR preview
+
+on:
+  pull_request_target:
+    types:
+      - opened
+
+permissions:
+  contents: read
+  pull-requests: write
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  documentation-links:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: readthedocs/actions/preview@b8bba1484329bda1a3abe986df7ebc80a8950333 # v1.5
+        with:
+          project-slug: "python-packaging-user-guide"

.github/workflows/test-translations.yml

@@ -0,0 +1,87 @@
+name: Test translations
+
+on:
+  workflow_dispatch:
+  pull_request:
+    paths:
+    - '**.po'
+    branches:
+    - translation/source
+  push:
+    paths:
+    - '**.po'
+    branches:
+    - translation/source
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.sha }}
+  cancel-in-progress: true
+
+env:
+  I18N_BRANCH: translation/source
+
+jobs:
+  matrix:
+    runs-on: ubuntu-latest
+    outputs:
+      languages: ${{ steps.languages.outputs.languages }}
+
+    steps:
+    - name: Grab the repo src
+      uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      with:
+        ref: ${{ env.I18N_BRANCH }}
+        persist-credentials: false
+
+    - name: List languages
+      id: languages
+      working-directory: locales
+      run: |
+        list=$(find * -maxdepth 0 -type d | jq -nRc '[inputs]')
+        echo "languages=$list" >> $GITHUB_OUTPUT
+
+
+  test-translation:
+    runs-on: ubuntu-latest
+    needs: matrix
+    strategy:
+      fail-fast: false
+      matrix:
+        language: ${{fromJson(needs.matrix.outputs.languages)}}
+
+    steps:
+    - name: Grab the repo src
+      uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      with:
+        ref: ${{ env.I18N_BRANCH }}
+        persist-credentials: false
+
+    - name: Set up Python
+      uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0
+      with:
+        python-version: >-
+          3.10
+
+    - name: Install Python tooling
+      run: python -m pip install --upgrade nox virtualenv sphinx-lint
+
+    - name: Set Sphinx problem matcher
+      uses: sphinx-doc/github-problem-matcher@1f74d6599f4a5e89a20d3c99aab4e6a70f7bda0f # v1.1
+
+    - name: Build translated docs in ${{ matrix.language }}
+      run: nox -s build -- -q -D language=${LANGUAGE}
+      env:
+        LANGUAGE: ${{ matrix.language }}
+
+    - name: Set Sphinx Lint problem matcher
+      if: always()
+      run: echo '::add-matcher::.github/sphinx_lint_matcher.json'
+
+    - name: Lint translation file
+      if: always()
+      run: sphinx-lint locales/${LANGUAGE}/LC_MESSAGES/messages.po
+      env:
+        LANGUAGE: ${{ matrix.language }}

.github/workflows/test.yml

@@ -0,0 +1,80 @@
+name: Test
+
+on:
+  merge_group:
+  push:
+    branches-ignore:
+    - gh-readonly-queue/**  # Temporary merge queue-related GH-made branches
+  pull_request:
+    types:
+    - opened  # default
+    - synchronize  # default
+    - reopened  # default
+    - ready_for_review  # used in PRs created from GitHub Actions workflows
+  workflow_call:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.sha }}
+  cancel-in-progress: true
+
+permissions: {}
+
+jobs:
+  build:
+    name: ${{ matrix.noxenv }}
+    if: ${{ github.repository_owner == 'pypa' || github.event_name != 'schedule' }}
+    runs-on: ubuntu-latest
+    timeout-minutes: 20
+    continue-on-error: >-
+      ${{ fromJSON(matrix.continue-on-error) }}
+    strategy:
+      matrix:
+        noxenv:
+        - build
+        continue-on-error:
+        - false
+        include:
+        - noxenv: linkcheck
+          continue-on-error: >-  # Don't block PRs on linkcheck unrelated failures
+            ${{ toJSON(github.event_name == 'pull_request') }}
+
+    steps:
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+        with:
+          persist-credentials: false
+
+      - name: Set up Python
+        uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0
+        with:
+          python-version: "3.11"
+          cache: 'pip'
+          cache-dependency-path: 'requirements.txt'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade nox virtualenv
+
+      - name: Nox ${{ matrix.noxenv }}
+        env:
+          # Authenticate github.com requests during linkcheck to avoid rate limits.
+          GITHUB_TOKEN: ${{ matrix.noxenv == 'linkcheck' && github.token || '' }}
+        run: |
+          python -m nox -s ${{ matrix.noxenv }}
+
+
+  check:
+    # This job does nothing and is only used for the branch protection
+    # or multi-stage CI jobs, like making sure that all tests pass before
+    # a publishing job is started.
+    if: always()
+
+    needs:
+    - build
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Decide whether the needed jobs succeeded or failed
+      uses: re-actors/alls-green@05ac9388f0aebcb5727afa17fcccfecd6f8ec5fe # v1.2.2
+      with:
+        jobs: ${{ toJSON(needs) }}

.github/workflows/translation.yml

@@ -0,0 +1,85 @@
+name: Translation
+
+on:
+  workflow_run:
+    workflows:
+    - Test
+    branches:
+    - main
+    types:
+    - completed
+
+env:
+  I18N_BRANCH: translation/source
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    if: github.repository_owner == 'pypa'
+
+    permissions:
+      contents: write # to push to I18N_BRANCH
+
+    steps:
+    - name: Grab the repo src
+      uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      with:
+        fetch-depth: 0  # To reach the common commit
+        persist-credentials: true # For `git push`
+    - name: Set up git user as [bot]
+      # Refs:
+      # * https://github.community/t/github-actions-bot-email-address/17204/6
+      # * https://github.com/actions/checkout/issues/13#issuecomment-724415212
+      uses: fregante/setup-git-user@024bc0b8e177d7e77203b48dab6fb45666854b35 # v2.0.2
+
+    - name: Switch to the translation source branch
+      run: |
+        sh -x
+
+        git fetch origin \
+          '+refs/heads/${{
+              env.I18N_BRANCH
+          }}:refs/remotes/origin/${{
+              env.I18N_BRANCH
+          }}'
+
+        git checkout -B '${{ env.I18N_BRANCH }}' \
+          'origin/${{ env.I18N_BRANCH }}'
+
+    - name: >-
+        Merge '${{ github.event.repository.default_branch }}'
+        to '${{ env.I18N_BRANCH }}'
+      run: |
+        sh -x
+
+        git merge "${DEFAULT_BRANCH}"
+      env:
+        DEFAULT_BRANCH: ${{ github.event.repository.default_branch }}
+
+    - name: Set up Python
+      uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0
+      with:
+        python-version: >-
+          3.10
+
+    - name: Install Python tooling
+      run: python -m pip install --upgrade nox virtualenv
+
+    - name: Generate a fresh POT file out of RST documents
+      run: python -m nox -s translation
+
+    - name: Commit the POT file to Git
+      run: |
+        git_hash=$(git rev-parse --short "${GITHUB_SHA}")
+        git add --force locales/messages.pot
+        git diff-index --quiet HEAD || \
+        git commit \
+          -m "Update messages.pot as of version ${git_hash}" \
+          locales/messages.pot
+
+    - name: >-
+        Push the updated POT file back to '${{ env.I18N_BRANCH }}'
+        branch on GitHub
+      if: always()
+      run: |
+        git push --atomic origin 'HEAD:${{ env.I18N_BRANCH }}'