Skip to content

ci: few security/permissions improvements #8681

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 18, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 28 additions & 1 deletion .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,19 @@ on:
branches:
- main
- "[0-9]+.[0-9]+.x"

env:
PYTEST_ADDOPTS: "--color=yes"

# Set permissions at the job level.
permissions: {}

jobs:
build:
runs-on: ${{ matrix.os }}
timeout-minutes: 30
permissions:
contents: read

strategy:
fail-fast: false
Expand Down Expand Up @@ -139,10 +145,13 @@ jobs:
- uses: actions/checkout@v2
with:
fetch-depth: 0
persist-credentials: false

- name: Set up Python ${{ matrix.python }}
uses: actions/setup-python@v2
with:
python-version: ${{ matrix.python }}

- name: Install dependencies
run: |
python -m pip install --upgrade pip
Expand All @@ -164,52 +173,70 @@ jobs:

linting:
runs-on: ubuntu-latest
permissions:
contents: read

steps:
- uses: actions/checkout@v2
with:
persist-credentials: false

- uses: actions/setup-python@v2

- name: set PY
run: echo "name=PY::$(python -c 'import hashlib, sys;print(hashlib.sha256(sys.version.encode()+sys.executable.encode()).hexdigest())')" >> $GITHUB_ENV

- uses: actions/cache@v2
with:
path: ~/.cache/pre-commit
key: pre-commit|${{ env.PY }}|${{ hashFiles('.pre-commit-config.yaml') }}

- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install tox

- run: tox -e linting

deploy:
if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags') && github.repository == 'pytest-dev/pytest'

runs-on: ubuntu-latest
timeout-minutes: 30
permissions:
contents: write

needs: [build]

steps:
- uses: actions/checkout@v2
with:
fetch-depth: 0
persist-credentials: false

- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: "3.7"

- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install --upgrade wheel setuptools tox

- name: Build package
run: |
python setup.py sdist bdist_wheel

- name: Publish package to PyPI
uses: pypa/gh-action-pypi-publish@master
with:
user: __token__
password: ${{ secrets.pypi_token }}

- name: Publish GitHub release notes
env:
GH_RELEASE_NOTES_TOKEN: ${{ secrets.release_notes }}
GH_RELEASE_NOTES_TOKEN: ${{ github.token }}
run: |
sudo apt-get install pandoc
tox -e publish-gh-release-notes
11 changes: 9 additions & 2 deletions .github/workflows/prepare-release-pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,21 @@ on:
required: true
default: 'no'

# Set permissions at the job level.
permissions: {}

jobs:
build:
runs-on: ubuntu-latest
permissions:
contents: write
pull-requests: write

steps:
- uses: actions/checkout@v2
with:
fetch-depth: 0
persist-credentials: false

- name: Set up Python
uses: actions/setup-python@v2
Expand All @@ -34,9 +41,9 @@ jobs:
- name: Prepare release PR (minor/patch release)
if: github.event.inputs.major == 'no'
run: |
tox -e prepare-release-pr -- ${{ github.event.inputs.branch }} ${{ secrets.chatops }}
tox -e prepare-release-pr -- ${{ github.event.inputs.branch }} ${{ github.token }}

- name: Prepare release PR (major release)
if: github.event.inputs.major == 'yes'
run: |
tox -e prepare-release-pr -- ${{ github.event.inputs.branch }} ${{ secrets.chatops }} --major
tox -e prepare-release-pr -- ${{ github.event.inputs.branch }} ${{ github.token }} --major
11 changes: 10 additions & 1 deletion .github/workflows/release-on-comment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,25 +7,34 @@ on:
issue_comment:
types: [created, edited]

# Set permissions at the job level.
permissions: {}

jobs:
build:
runs-on: ubuntu-latest
permissions:
contents: write
issues: write

if: (github.event.comment && startsWith(github.event.comment.body, '@pytestbot please')) || (github.event.issue && !github.event.comment && startsWith(github.event.issue.body, '@pytestbot please'))

steps:
- uses: actions/checkout@v2
with:
fetch-depth: 0
persist-credentials: false

- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: "3.8"

- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install --upgrade setuptools tox

- name: Prepare release
run: |
tox -e release-on-comment -- $GITHUB_EVENT_PATH ${{ secrets.chatops }}
tox -e release-on-comment -- $GITHUB_EVENT_PATH ${{ github.token }}
13 changes: 13 additions & 0 deletions .github/workflows/update-plugin-list.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,22 +7,35 @@ on:
- cron: '0 0 * * 0'
workflow_dispatch:

# Set permissions at the job level.
permissions: {}

jobs:
createPullRequest:
runs-on: ubuntu-latest
permissions:
contents: write
pull-requests: write

steps:
- name: Checkout
uses: actions/checkout@v2
with:
fetch-depth: 0

- name: Setup Python
uses: actions/setup-python@v2
with:
python-version: 3.8

- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install packaging requests tabulate[widechars]

- name: Update Plugin List
run: python scripts/update-plugin-list.py

- name: Create Pull Request
uses: peter-evans/create-pull-request@2455e1596942c2902952003bbb574afbbe2ab2e6
with:
Expand Down
5 changes: 2 additions & 3 deletions scripts/prepare-release-pr.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,8 @@

After that, it will create a release using the `release` tox environment, and push a new PR.

**Secret**: currently the secret is defined in the @pytestbot account,
which the core maintainers have access to. There we created a new secret named `chatops`
with write access to the repository.
**Token**: currently the token from the GitHub Actions is used, pushed with
`pytest bot <[email protected]>` commit author.
"""
import argparse
import re
Expand Down
4 changes: 2 additions & 2 deletions scripts/release-on-comment.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@

After that, it will create a release using the `release` tox environment, and push a new PR.

**Secret**: currently the secret is defined in the @pytestbot account, which the core maintainers
have access to. There we created a new secret named `chatops` with write access to the repository.
**Token**: currently the token from the GitHub Actions is used, pushed with
`pytest bot <[email protected]>` commit author.
"""
import argparse
import json
Expand Down
20 changes: 16 additions & 4 deletions scripts/upload-coverage.sh
Original file line number Diff line number Diff line change
@@ -1,16 +1,28 @@
#!/usr/bin/env bash

set -e
set -euo pipefail
set -x

if [ -z "$TOXENV" ]; then
# Install coverage.
if [[ -z ${TOXENV+x} || -z $TOXENV ]]; then
python -m pip install coverage
else
# Add last TOXENV to $PATH.
PATH="$PWD/.tox/${TOXENV##*,}/bin:$PATH"
fi

# Run coverage.
python -m coverage xml

# Download and verify latest Codecov bash uploader.
# Set --connect-timeout to work around https://github.com/curl/curl/issues/4461
curl -S -L --connect-timeout 5 --retry 6 -s https://codecov.io/bash -o codecov-upload.sh
bash codecov-upload.sh -Z -X fix -f coverage.xml "$@"
curl --silent --show-error --location --connect-timeout 5 --retry 6 -o codecov https://codecov.io/bash
VERSION=$(grep --only-matching 'VERSION=\"[0-9\.]*\"' codecov | cut -d'"' -f2)
if command -v sha256sum; then
sha256sum --check --strict --ignore-missing --quiet <(curl --silent "https://raw.githubusercontent.com/codecov/codecov-bash/${VERSION}/SHA256SUM")
else
shasum --algorithm 256 --check --strict --ignore-missing --quiet <(curl --silent "https://raw.githubusercontent.com/codecov/codecov-bash/${VERSION}/SHA256SUM")
fi

# Upload coverage.
bash codecov -Z -X fix -f coverage.xml "$@"