Update CI files for branch 0.4

.github/template_gitref

@@ -1 +1 @@
-2021.08.26-279-gea3c2fb
+2021.08.26-290-g4d54366

.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_gem"
-      - 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"

.github/workflows/changelog.yml

@@ -6,53 +6,53 @@
 # For more info visit https://github.com/pulp/plugin_template
 
 ---
-name: Gem changelog update
+name: "Gem 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 }}"

.github/workflows/ci.yml

@@ -6,7 +6,7 @@
 # For more info visit https://github.com/pulp/plugin_template
 
 ---
-name: Gem CI
+name: "Gem CI"
 on: {pull_request: {branches: ['*']}}
 
 concurrency:
@@ -18,49 +18,46 @@ defaults:
     working-directory: "pulp_gem"
 
 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_gem"
-      - uses: actions/setup-python@v4
+      - uses: "actions/setup-python@v4"
         with:
           python-version: "3.8"
-      - name: Verify requirements files
-        run: python .ci/scripts/check_requirements.py
+      - 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_gem"
+        working-directory: "."
+      - name: "Download Deprecations"
+        uses: actions/download-artifact@v3
+        with:
+          name: "deprecations"
+          path: "pulp_gem"
+      - 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:]]'

.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_gem"
 
-      - 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_gem
-        run: python3 .github/workflows/scripts/secrets.py "$SECRETS_CONTEXT"
+      - name: "Setting secrets"
+        working-directory: "pulp_gem"
+        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_gem

.github/workflows/lint.yml

@@ -19,18 +19,20 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: "actions/checkout@v4"
         with:
           fetch-depth: 1
           path: "pulp_gem"
 
-      - 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: |

.github/workflows/nightly.yml

@@ -33,22 +33,22 @@ jobs:
   changelog:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: "actions/checkout@v4"
         with:
           fetch-depth: 0
           path: "pulp_gem"
 
-      - uses: actions/setup-python@v4
+      - uses: "actions/setup-python@v4"
         with:
           python-version: "3.11"
 
-      - name: Install python dependencies
+      - name: "Install python dependencies"
         run: |
           echo ::group::PYDEPS
           pip install gitpython toml
           echo ::endgroup::
 
-      - name: Configure Git with pulpbot name and email
+      - name: "Configure Git with pulpbot name and email"
         run: |
           git config --global user.name 'pulpbot'
           git config --global user.email '[email protected]'
@@ -71,7 +71,7 @@ jobs:
     needs: test
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: "actions/checkout@v4"
         with:
           fetch-depth: 1
           path: "pulp_gem"
@@ -81,17 +81,17 @@ jobs:
           name: "plugin_package"
           path: "pulp_gem/dist/"
 
-      - 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 requests
+          pip install requests 'packaging~=21.3' mkdocs pymdown-extensions 'Jinja2<3.1'
           echo ::endgroup::
 
-      - name: Set environment variables
+      - name: "Set environment variables"
         run: |
           echo "TEST=${{ matrix.env.TEST }}" >> $GITHUB_ENV
 
@@ -107,24 +107,13 @@ jobs:
           name: "python-client-docs.tar"
           path: "pulp_gem"
 
-      - name: Setting secrets
-        run: python3 .github/workflows/scripts/secrets.py "$SECRETS_CONTEXT"
+      - name: "Setting secrets"
+        run: |
+          python3 .github/workflows/scripts/secrets.py "$SECRETS_CONTEXT"
         env:
-          SECRETS_CONTEXT: ${{ toJson(secrets) }}
+          SECRETS_CONTEXT: "${{ toJson(secrets) }}"
 
       - name: Publish docs to pulpproject.org
         run: |
           tar -xvf docs.tar -C ./docs
           .github/workflows/scripts/publish_docs.sh nightly ${GITHUB_REF##*/}
-
-      - name: Logs
-        if: always()
-        run: |
-          echo "Need to debug? Please check: https://github.com/marketplace/actions/debugging-with-tmate"
-          http --timeout 30 --check-status --pretty format --print hb "https://pulp${PULP_API_ROOT}api/v3/status/" || true
-          docker images || true
-          docker ps -a || true
-          docker logs pulp || true
-          docker exec pulp ls -latr /etc/yum.repos.d/ || true
-          docker exec pulp cat /etc/yum.repos.d/* || true
-          docker exec pulp bash -c "pip3 list && pip3 install pipdeptree && pipdeptree"

.github/workflows/pr_checks.yml

@@ -26,7 +26,7 @@ jobs:
     permissions:
       pull-requests: write
     steps:
-      - uses: actions/checkout@v4
+      - uses: "actions/checkout@v4"
         with:
           fetch-depth: 0
       - name: Commit Count Check