Update CI files

[noissue]
pulp · Dec 4, 2023 · d991a22 · d991a22
1 parent 3152d21
commit d991a22
Show file tree

Hide file tree

Showing 25 changed files with 540 additions and 409 deletions.
diff --git a/.github/template_gitref b/.github/template_gitref
@@ -1 +1 @@
-2021.08.26-276-g45ce134
+2021.08.26-290-g4d54366
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -19,21 +19,23 @@ jobs:
     runs-on: "ubuntu-latest"
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: "actions/checkout@v4"
         with:
           fetch-depth: 1
           path: "pulp_container"
-      - uses: actions/setup-python@v4
+      - uses: "actions/setup-python@v4"
         with:
           python-version: "3.8"
-      - name: Install python dependencies
+      - name: "Install python dependencies"
         run: |
           echo ::group::PYDEPS
-          pip install packaging wheel
+          pip install packaging twine wheel
           echo ::endgroup::
       - name: "Build package"
-        run: "python3 setup.py sdist bdist_wheel --python-tag py3"
-      - name: 'Upload Package whl'
+        run: |
+          python3 setup.py sdist bdist_wheel --python-tag py3
+          twine check dist/*
+      - name: "Upload Package whl"
         uses: "actions/upload-artifact@v3"
         with:
           name: "plugin_package"

diff --git a/.github/workflows/changelog.yml b/.github/workflows/changelog.yml
@@ -6,53 +6,53 @@
 # For more info visit https://github.com/pulp/plugin_template
 
 ---
-name: Container changelog update
+name: "Container changelog update"
 on:
   push:
     branches:
-      - main
+      - "main"
     paths:
-      - CHANGES.rst
-      - CHANGES.md
+      - "CHANGES.rst"
+      - "CHANGES.md"
   workflow_dispatch:
 
 jobs:
 
   update-changelog:
-    runs-on: ubuntu-latest
+    runs-on: "ubuntu-latest"
     strategy:
       fail-fast: false
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: "actions/checkout@v4"
         with:
           fetch-depth: 1
 
-      - uses: actions/setup-python@v4
+      - uses: "actions/setup-python@v4"
         with:
           python-version: "3.8"
 
-      - name: Install python dependencies
+      - name: "Install python dependencies"
         run: |
           echo ::group::PYDEPS
           pip install -r doc_requirements.txt
           echo ::endgroup::
 
-      - name: Fake api schema
+      - name: "Fake api schema"
         run: |
           mkdir -p docs/_build/html
           echo "{}" > docs/_build/html/api.json
           mkdir -p docs/_static
           echo "{}" > docs/_static/api.json
-      - name:
+      - name: "Build Docs"
         run: |
-          pip install "Jinja2<3.1"
           make diagrams html
-        working-directory: ./docs
+        working-directory: "./docs"
         env:
           PULP_CONTENT_ORIGIN: "http://localhost/"
 
-      - name: Publish changlog to pulpproject.org
-        run: .github/workflows/scripts/publish_docs.sh changelog ${GITHUB_REF##*/}
+      - name: "Publish changlog to pulpproject.org"
+        run: |
+          .github/workflows/scripts/publish_docs.sh changelog ${GITHUB_REF##*/}
         env:
-          PULP_DOCS_KEY: ${{ secrets.PULP_DOCS_KEY }}
+          PULP_DOCS_KEY: "${{ secrets.PULP_DOCS_KEY }}"
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -6,7 +6,7 @@
 # For more info visit https://github.com/pulp/plugin_template
 
 ---
-name: Container CI
+name: "Container CI"
 on: {pull_request: {branches: ['*']}}
 
 concurrency:
@@ -18,60 +18,60 @@ defaults:
     working-directory: "pulp_container"
 
 jobs:
-
   ready-to-ship:
-    runs-on: ubuntu-latest
+    runs-on: "ubuntu-latest"
     steps:
-      - uses: actions/checkout@v4
+      - uses: "actions/checkout@v4"
         with:
           fetch-depth: 0
           path: "pulp_container"
-      - uses: actions/setup-python@v4
+      - uses: "actions/setup-python@v4"
         with:
           python-version: "3.8"
-      - name: Install requirements
-        run: pip3 install github
-      - name: Check commit message
+      - name: "Install python dependencies"
+        run: |
+          echo ::group::PYDEPS
+          pip install requests pygithub
+          echo ::endgroup::
+      - name: "Check commit message"
         if: github.event_name == 'pull_request'
         env:
-          PY_COLORS: '1'
-          ANSIBLE_FORCE_COLOR: '1'
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          GITHUB_CONTEXT: ${{ github.event.pull_request.commits_url }}
-        run: sh .github/workflows/scripts/check_commit.sh
-      - name: Verify requirements files
-        run: python .ci/scripts/check_requirements.py
+          PY_COLORS: "1"
+          ANSIBLE_FORCE_COLOR: "1"
+          GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
+          GITHUB_CONTEXT: "${{ github.event.pull_request.commits_url }}"
+        run: |
+          .github/workflows/scripts/check_commit.sh
+      - name: "Verify requirements files"
+        run: |
+          python .ci/scripts/check_requirements.py
 
   lint:
     uses: "./.github/workflows/lint.yml"
 
   build:
-    needs: lint
+    needs: "lint"
     uses: "./.github/workflows/build.yml"
 
   test:
-    needs: build
+    needs: "build"
     uses: "./.github/workflows/test.yml"
+
   deprecations:
-    defaults:
-      run:
-        working-directory: "."
-    runs-on: ubuntu-latest
+    runs-on: "ubuntu-latest"
     if: github.base_ref == 'main'
-    needs: test
+    needs: "test"
     steps:
-      - name: Fail on deprecations
+      - name: "Create working directory"
         run: |
-          test -z "${{ needs.test.outputs.deprecations-pulp }}"
-          test -z "${{ needs.test.outputs.deprecations-azure }}"
-          test -z "${{ needs.test.outputs.deprecations-s3 }}"
-          test -z "${{ needs.test.outputs.deprecations-lowerbounds }}"
-      - name: Print deprecations
-        if: failure()
+          mkdir -p "pulp_container"
+        working-directory: "."
+      - name: "Download Deprecations"
+        uses: actions/download-artifact@v3
+        with:
+          name: "deprecations"
+          path: "pulp_container"
+      - name: "Print deprecations"
         run: |
-          echo "${{ needs.test.outputs.deprecations-pulp }}" | base64 -d
-          echo "${{ needs.test.outputs.deprecations-azure }}" | base64 -d
-          echo "${{ needs.test.outputs.deprecations-s3 }}" | base64 -d
-          echo "${{ needs.test.outputs.deprecations-lowerbounds }}" | base64 -d
-
-
+          cat deprecations-*.txt | sort -u
+          ! cat deprecations-*.txt | grep '[^[:space:]]'
diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
@@ -30,13 +30,13 @@ jobs:
         language: [ 'python' ]
 
     steps:
-    - name: Checkout repository
-      uses: actions/checkout@v3
+      - name: Checkout repository
+        uses: actions/checkout@v3
 
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
-      with:
-        languages: ${{ matrix.language }}
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v2
+        with:
+          languages: ${{ matrix.language }}
 
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v2
diff --git a/.github/workflows/create-branch.yml b/.github/workflows/create-branch.yml
@@ -21,26 +21,27 @@ jobs:
       fail-fast: false
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: "actions/checkout@v4"
         with:
           fetch-depth: 0
           path: "pulp_container"
 
-      - uses: actions/setup-python@v4
+      - uses: "actions/setup-python@v4"
         with:
           python-version: "3.8"
 
-      - name: Install python dependencies
+      - name: "Install python dependencies"
         run: |
           echo ::group::PYDEPS
           pip install bump2version jinja2 pyyaml
           echo ::endgroup::
 
-      - name: Setting secrets
-        working-directory: pulp_container
-        run: python3 .github/workflows/scripts/secrets.py "$SECRETS_CONTEXT"
+      - name: "Setting secrets"
+        working-directory: "pulp_container"
+        run: |
+          python3 .github/workflows/scripts/secrets.py "$SECRETS_CONTEXT"
         env:
-          SECRETS_CONTEXT: ${{ toJson(secrets) }}
+          SECRETS_CONTEXT: "${{ toJson(secrets) }}"
 
       - name: Determine new branch name
         working-directory: pulp_container

diff --git a/.github/workflows/kanban.yml b/.github/workflows/kanban.yml
@@ -58,7 +58,7 @@ jobs:
     runs-on: ubuntu-latest
     name: Find issues linked to a PR
     outputs:
-        linked-issues: ${{ steps.linked-issues.outputs.issues }}
+      linked-issues: ${{ steps.linked-issues.outputs.issues }}
     steps:
       - name: Checkout
         uses: actions/checkout@v2

diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -19,18 +19,24 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: "actions/checkout@v4"
         with:
           fetch-depth: 1
           path: "pulp_container"
 
-      - uses: actions/setup-python@v4
+      - uses: "actions/setup-python@v4"
         with:
           python-version: "3.8"
 
-      # lint_requirements contains tools needed for flake8, etc.
-      - name: Install requirements
-        run: pip3 install -r lint_requirements.txt
+      - name: "Install python dependencies"
+        run: |
+          echo ::group::PYDEPS
+          pip install -r lint_requirements.txt
+          echo ::endgroup::
+
+      - name: Lint workflow files
+        run: |
+          yamllint -s -d '{extends: relaxed, rules: {line-length: disable}}' .github/workflows
 
       # run black separately from flake8 to get a diff
       - name: Run black