ansible-doc-template-extractor 0.5.0__tar.gz

ansible_doc_template_extractor-0.5.0/.bandit.toml

@@ -0,0 +1,8 @@
+# Bandit config file in TOML format
+
+[tool.bandit]
+
+# Checks to be ignored:
+skips = [
+  'B101',  # assert_used
+]

ansible_doc_template_extractor-0.5.0/.flake8

@@ -0,0 +1,12 @@
+[flake8]
+max_line_length = 80
+
+ignore =
+
+exclude =
+    .git,
+    .tox,
+    __pycache__,
+    *.pyc,
+    build_doc,
+    dist

ansible_doc_template_extractor-0.5.0/.github/workflows/notify.yml

@@ -0,0 +1,35 @@
+# This GitHub workflow will send a notification to Slack when a scheduled test
+# workflow completes.
+
+# There needs to be a GitHub secret named "SLACK_HOOK" that is set to the
+# incoming webhook URL for Slack. That webhook is tied to a Slack channel, so
+# this workflow does not select the channel and relies on that default.
+# Instructions to set up Slack for incoming webhooks are here:
+# https://api.slack.com/messaging/webhooks.
+
+name: notify
+
+on:
+  workflow_run:
+    workflows:
+      - test
+    types:
+      - completed
+
+jobs:
+
+  notify:
+    runs-on: ubuntu-latest
+    if: ${{ github.event.workflow_run.event == 'schedule' }}
+    steps:
+
+    - name: Post status to Slack
+      run: |
+        run_id=$(echo "${{ github.event.workflow_run.url }}" | rev | cut -d '/' -f 1 | rev)
+        run_url="https://github.com/${{ github.repository }}/actions/runs/$run_id"
+        branch="${{ github.event.workflow_run.head_branch }}"
+        branch_url="https://github.com/${{ github.repository }}/commits/$branch"
+        repo_url="https://github.com/${{ github.repository }}/actions/workflows/test.yml"
+        emoji=$(if [[ "${{ github.event.workflow_run.conclusion }}" == "success" ]]; then echo ":white_check_mark:"; else echo ":x:"; fi)
+        json="{ \"text\": \"$emoji <$repo_url|${{ github.repository }}>: Scheduled run <$run_url|$run_id> on branch <$branch_url|$branch>: ${{ github.event.workflow_run.conclusion }}\" }"
+        curl -s -d "payload=$json" ${{ secrets.SLACK_HOOK }}

ansible_doc_template_extractor-0.5.0/.github/workflows/publish.yml

@@ -0,0 +1,221 @@
+# This GitHub workflow will publish the package to Pypi and create a new stable branch when releasing the main branch.
+# For more information see:
+# https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+# https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/
+
+name: publish
+
+on:
+  push:  # When pushing a tag
+    tags:
+    - "*"
+    - "!*a0"  # Exclude initial tag for a new version
+
+jobs:
+  publish:
+    name: Build and publish to PyPI
+    if: startsWith(github.ref, 'refs/tags')
+    runs-on: ubuntu-latest
+    # This workflow uses Pypi trusted publishing, see https://docs.pypi.org/trusted-publishers/
+    # Requirements:
+    # - On the Pypi project, the GitHub repo must be defined as a trusted publisher
+    # - On the GitHub repo, an environment 'pypi' must exist
+    environment: pypi  # For Pypi trusted publishing
+    permissions:
+      id-token: write  # For Pypi trusted publishing
+      contents: write  # For creating GitHub release
+    steps:
+
+    #-------- Info gathering and checks
+    - name: Set pushed tag
+      id: set-tag
+      uses: actions/github-script@v8
+      with:
+        result-encoding: string
+        script: |
+          const result = "${{ github.ref }}".match("refs/tags/(.*)$")[1]
+          console.log(result)
+          return result
+    - name: Check validity of pushed tag
+      run: |
+        if [[ ${{ steps.set-tag.outputs.result }} =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
+          echo "Pushed tag '${{ steps.set-tag.outputs.result }}' is valid";
+        else
+          echo "Pushed tag '${{ steps.set-tag.outputs.result }}' is invalid (must be 'M.N.U')";
+          false;
+        fi
+    - name: Determine whether releasing the main branch
+      id: set-is-main-branch
+      uses: actions/github-script@v8
+      with:
+        result-encoding: string
+        script: |
+          const resp = await github.rest.git.getRef({
+            owner: context.repo.owner,
+            repo: context.repo.repo,
+            ref: "heads/main",
+          })
+          const result = (resp.data.object.sha == "${{ github.sha }}")
+          console.log(result)
+          return result
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    - name: Determine name of stable branch for pushed tag
+      id: set-stable-branch
+      uses: actions/github-script@v8
+      with:
+        result-encoding: string
+        script: |
+          const result = "stable_"+"${{ steps.set-tag.outputs.result }}".match("([0-9]+\.[0-9]+)\.")[1]
+          console.log(result)
+          return result
+    - name: Determine whether releasing stable branch for pushed tag
+      id: set-is-stable-branch
+      uses: actions/github-script@v8
+      with:
+        result-encoding: string
+        script: |
+          var resp
+          try {
+            resp = await github.rest.git.getRef({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              ref: "heads/${{ steps.set-stable-branch.outputs.result }}",
+            })
+          }
+          catch(err) {
+            console.log("false (stable branch does not exist: "+err+")")
+            return false
+          }
+          const result = (resp.data.object.sha == "${{ github.sha }}")
+          console.log(result)
+          return result
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    - name: Check released commit to be main branch or stable branch for pushed tag
+      run: |
+        if [[ ${{ steps.set-is-main-branch.outputs.result }} == 'false' && ${{ steps.set-is-stable-branch.outputs.result }} == 'false' ]]; then
+          echo "Released commit is not 'main' or '${{ steps.set-stable-branch.outputs.result }}' branch";
+          false;
+        fi
+    - name: Set update version
+      id: set-update-version
+      uses: actions/github-script@v8
+      with:
+        result-encoding: string
+        script: |
+          const result = "${{ steps.set-tag.outputs.result }}".match("[0-9]+\.[0-9]+\.([0-9]+)")[1]
+          console.log(result)
+          return result
+    - name: Check update version to be 0 when releasing main branch
+      if: ${{ steps.set-is-main-branch.outputs.result == 'true' }}
+      run: |
+        if [[ ${{ steps.set-update-version.outputs.result }} != '0' ]]; then
+          echo "Update version '${{ steps.set-update-version.outputs.result }}' in tag '${{ steps.set-tag.outputs.result }}' is invalid (must be 0 when releasing main branch)";
+          false;
+        fi
+    - name: Check update version to be non-0 when releasing stable branch for pushed tag
+      if: ${{ steps.set-is-stable-branch.outputs.result == 'true' }}
+      run: |
+        if [[ ${{ steps.set-update-version.outputs.result }} == '0' ]]; then
+          echo "Update version '${{ steps.set-update-version.outputs.result }}' in tag '${{ steps.set-tag.outputs.result }}' is invalid (must be non-0 when releasing stable branch for pushed tag)";
+          false;
+        fi
+
+    #-------- Setup of work environment
+    - name: Checkout repo
+      uses: actions/checkout@v5
+      with:
+        fetch-depth: 0
+    - name: Set up Python
+      uses: actions/setup-python@v6
+      with:
+        python-version: "3.14"
+    - name: Development setup
+      run: |
+        make develop
+    - name: Display Python packages
+      run: |
+        pip list
+
+    #-------- Publishing of package
+    - name: Build the distribution
+      run: |
+        make build
+    - name: Display the distribution directory
+      run: |
+        ls -l dist
+    - name: Publish distribution to PyPI
+      if: startsWith(github.ref, 'refs/tags')
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        packages-dir: dist
+        # Pypi trusted publishing allows to have no password
+
+    #-------- Creation of Github release
+    - name: Determine whether release on Github exists for the pushed tag
+      id: set-release-exists
+      uses: octokit/request-action@v2.x
+      with:
+        route: GET /repos/${{ github.repository }}/releases/tags/${{ steps.set-tag.outputs.result }}
+      continue-on-error: true
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    - name: Create release on Github for the pushed tag if it does not exist
+      if: ${{ steps.set-release-exists.outputs.status == 404 }}
+      uses: octokit/request-action@v2.x
+      with:
+        route: POST /repos/${{ github.repository }}/releases
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        INPUT_TAG_NAME: ${{ steps.set-tag.outputs.result }}
+        INPUT_NAME: "Release ${{ steps.set-tag.outputs.result }}"
+        INPUT_BODY: "Change log https://ansible-doc-template-extractor.readthedocs.io/en/stable/changes.html"
+
+    #-------- Creation of stable branch
+    # Note: This does not seem to depend on the disablement of the "Restrict pushes
+    # that create matching branches" setting in the branch protection rules for stable_*.
+    # It is possible that this fails with HTTP 422, for unknown reasons.
+    - name: Create new stable branch when releasing main branch
+      if: steps.set-is-main-branch.outputs.result == 'true'
+      id: create-stable-branch
+      uses: actions/github-script@v8
+      with:
+        script: |
+          github.rest.git.createRef({
+            owner: context.repo.owner,
+            repo: context.repo.repo,
+            ref: "refs/heads/${{ steps.set-stable-branch.outputs.result }}",
+            sha: "${{ github.sha }}",
+          })
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      continue-on-error: true
+    - name: Wait some time if HTTP error 422
+      if: steps.set-is-main-branch.outputs.result == 'true' && steps.create-stable-branch.outputs.status == 422
+      run: |
+        sleep 10
+    - name: Retry create new stable branch when releasing main branch if HTTP error 422
+      if: steps.set-is-main-branch.outputs.result == 'true' && steps.create-stable-branch.outputs.status == 422
+      id: create-stable-branch-2
+      uses: actions/github-script@v8
+      with:
+        script: |
+          github.rest.git.createRef({
+            owner: context.repo.owner,
+            repo: context.repo.repo,
+            ref: "refs/heads/${{ steps.set-stable-branch.outputs.result }}",
+            sha: "${{ github.sha }}",
+          })
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      continue-on-error: true
+    - name: Handle HTTP error 422 from creating the new stable branch
+      if: steps.set-is-main-branch.outputs.result == 'true' && steps.create-stable-branch-2.outputs.status == 422
+      run: |
+        echo "Error: Creating the new stable branch ${{ steps.set-stable-branch.outputs.result }} failed twice, but the publish still succeeded. Create the new stable branch manually:"
+        echo "git checkout main"
+        echo "git pull"
+        echo "git checkout -b ${{ steps.set-stable-branch.outputs.result }}"
+        echo "git push --set-upstream origin ${{ steps.set-stable-branch.outputs.result }}"
+        false

ansible_doc_template_extractor-0.5.0/.github/workflows/test.yml

@@ -0,0 +1,207 @@
+# This GitHub workflow will setup and run various kinds of tests with a variety of Python versions
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: test
+
+on:
+  schedule:
+    # The schedule event always (and only) runs on the main branch.
+    - # cron (in UTC): minute hour day_of_month month day_of_week
+      cron: '00 22 * * SAT'
+  pull_request:  # When creating a PR targeting these branches
+    branches:
+    - main
+    - stable_*
+  push:  # When merging a PR targeting these branches (direct push is disabled)
+    branches:
+    - main
+    - stable_*
+
+jobs:
+
+  set_matrix:
+    runs-on: ubuntu-latest
+    outputs:
+      matrix: ${{ steps.select_matrix.outputs.matrix }}
+    steps:
+    - name: "Select matrix"
+      id: select_matrix
+      # Select full matrix when scheduled or when releasing, and normal matrix
+      # otherwise. The matrix is defined as a JSON string.
+      # This technique documented in:
+      #    https://stackoverflow.com/questions/65384420/how-to-make-a-github-action-matrix-element-conditional
+      # TODO: Find a way to define this with less escapes.
+      run: |
+        if [[ "${{ github.event_name }}" == "schedule" || "${{ github.head_ref }}" =~ ^release_ ]]; then \
+          echo "matrix={ \
+            \"os\": [ \"ubuntu-latest\", \"macos-latest\", \"windows-latest\" ], \
+            \"python-version\": [ \"3.8\", \"3.9\", \"3.10\", \"3.11\", \"3.12\", \"3.13\", \"3.14\" ], \
+            \"exclude\": [ \
+              { \
+                \"os\": \"ubuntu-latest\", \
+                \"python-version\": \"3.8\", \
+              } \
+            ], \
+            \"include\": [ \
+              { \
+                \"os\": \"ubuntu-22.04\", \
+                \"python-version\": \"3.8\", \
+              } \
+            ] \
+          }" >> $GITHUB_OUTPUT; \
+        else \
+          echo "matrix={ \
+            \"os\": [ \"ubuntu-latest\" ], \
+            \"python-version\": [ \"3.14\" ], \
+            \"include\": [ \
+              { \
+                \"os\": \"ubuntu-22.04\", \
+                \"python-version\": \"3.8\", \
+              }, \
+              { \
+                \"os\": \"ubuntu-latest\", \
+                \"python-version\": \"3.9\", \
+              }, \
+              { \
+                \"os\": \"macos-latest\", \
+                \"python-version\": \"3.8\", \
+              }, \
+              { \
+                \"os\": \"macos-latest\", \
+                \"python-version\": \"3.14\", \
+              }, \
+              { \
+                \"os\": \"windows-latest\", \
+                \"python-version\": \"3.8\", \
+              }, \
+              { \
+                \"os\": \"windows-latest\", \
+                \"python-version\": \"3.14\", \
+              } \
+            ] \
+          }" >> $GITHUB_OUTPUT; \
+        fi
+    - name: Show matrix in JSON
+      run: echo '${{ steps.select_matrix.outputs.matrix }}'
+
+  test:
+    needs: set_matrix
+    strategy:
+      fail-fast: false
+      max-parallel: 20
+      matrix: ${{ fromJson(needs.set_matrix.outputs.matrix) }}
+    runs-on: ${{ matrix.os }}
+    env:
+      PIP_DISABLE_PIP_VERSION_CHECK: 1
+    steps:
+    - name: Set run type (normal, scheduled, release)
+      id: set-run-type
+      uses: actions/github-script@v8
+      with:
+        result-encoding: string
+        script: |
+          var result
+          if ("${{ github.event_name }}" == "schedule") {
+            result = "scheduled"
+          } else if ("${{ github.head_ref }}".match(/^release_/)) {
+            result = "release"
+          } else {
+            result = "normal"
+          }
+          console.log(result)
+          return result
+    - name: Checkout repo
+      uses: actions/checkout@v5
+      with:
+        fetch-depth: 0
+    - name: Check commit messages - Signed-off-by
+      if: github.event_name != 'schedule'
+      uses: gsactions/commit-message-checker@v2
+      with:
+        pattern: '^Signed-off-by: [^<>]+ <[^<>]+>$'
+        flags: 'gm'
+        excludeDescription: true
+        excludeTitle: true
+        checkAllCommitMessages: true
+        accessToken: ${{ secrets.GITHUB_TOKEN }}
+        error: Commit message has no or incorrectly formatted signed-off-by line
+    - name: Check commit messages - Line length
+      if: github.event_name != 'schedule'
+      uses: gsactions/commit-message-checker@v2
+      with:
+        pattern: '^.{1,80}\n\n(.{0,80}\n)*.{0,80}$'
+        flags: ''
+        excludeDescription: true
+        excludeTitle: true
+        checkAllCommitMessages: true
+        accessToken: ${{ secrets.GITHUB_TOKEN }}
+        error: Commit message title or body exceeds maximum line length of 80
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v6
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Display environment
+      env:
+        RUN_TYPE: ${{ steps.set-run-type.outputs.result }}
+      run: |
+        make env
+    - name: Display initial Python packages
+      run: |
+        echo "Installed Python packages:"
+        pip list
+    - name: Display platform
+      env:
+        RUN_TYPE: ${{ steps.set-run-type.outputs.result }}
+      run: |
+        make platform
+    - name: Install the package and its dependents
+      env:
+        RUN_TYPE: ${{ steps.set-run-type.outputs.result }}
+      run: |
+        make install
+    - name: Show installed package versions
+      run: |
+        echo "Installed Python packages:"
+        pip list
+    - name: Development setup
+      env:
+        RUN_TYPE: ${{ steps.set-run-type.outputs.result }}
+      run: |
+        make develop
+    - name: Show installed package versions
+      run: |
+        echo "Installed Python packages:"
+        pip list
+    - name: Run build
+      env:
+        RUN_TYPE: ${{ steps.set-run-type.outputs.result }}
+      run: |
+        make build
+    - name: Run check
+      env:
+        RUN_TYPE: ${{ steps.set-run-type.outputs.result }}
+      run: |
+        make check
+    - name: Run ruff
+      env:
+        RUN_TYPE: ${{ steps.set-run-type.outputs.result }}
+      run: |
+        make ruff
+    - name: Run pylint
+      env:
+        RUN_TYPE: ${{ steps.set-run-type.outputs.result }}
+      run: |
+        make pylint
+    - name: Run bandit
+      env:
+        RUN_TYPE: ${{ steps.set-run-type.outputs.result }}
+      run: |
+        make bandit
+
+  test_finish:
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+    - name: Dummy step to define required tests in GitHub
+      run: |
+        echo Dummy step to define required tests in GitHub

ansible_doc_template_extractor-0.5.0/.gitignore

@@ -0,0 +1,26 @@
+# Make targets
+/done/*.done
+
+# Make build
+/build/
+/dist/
+/src/ansible_doc_template_extractor/_version_scm.py
+/src/*.egg-info/
+/MANIFEST
+/MANIFEST.in
+
+# Make test
+__pycache__/
+/.pytest_cache/
+/htmlcov/
+/.coverage
+
+# Make build_doc
+/build_docs/
+
+# Other
+*.swp
+.DS_Store
+/try/
+*.log
+*.tmp

ansible_doc_template_extractor-0.5.0/.mailmap

@@ -0,0 +1,7 @@
+# git mailmap file for consolidating git commit names and email addresses
+# For details, see: https://git-scm.com/docs/git-check-mailmap
+#
+# Format for replacing name and email based upon commit email:
+#    Proper Name <proper@email.xx> <commit@email.xx>
+#
+Andreas Maier <maiera@de.ibm.com> <andy-maier@users.noreply.github.com>