Skip to content

Commit cfe0017

Browse files
mdellwegmdellweg
authored
Merge pull request #720 from pulp/update-ci/main
Update CI files for branch main
2 parents f37d2bc + 81f7eeb commit cfe0017

12 files changed

+84
-61
lines changed

‎.ci/scripts/validate_commit_message.py

+2-6
Original file line numberDiff line numberDiff line change
@@ -9,21 +9,17 @@
99
import sys
1010
from pathlib import Path
1111
import subprocess
12-
13-
1412
import os
1513
import warnings
1614
from github import Github
1715

18-
1916
NO_ISSUE = "[noissue]"
2017
CHANGELOG_EXTS = [".feature", ".bugfix", ".doc", ".removal", ".misc", ".deprecation"]
18+
KEYWORDS = ["fixes", "closes"]
19+
2120
sha = sys.argv[1]
2221
message = subprocess.check_output(["git", "log", "--format=%B", "-n 1", sha]).decode("utf-8")
2322

24-
25-
KEYWORDS = ["fixes", "closes"]
26-
2723
g = Github(os.environ.get("GITHUB_TOKEN"))
2824
repo = g.get_repo("pulp/pulp_python")
2925

‎.github/template_gitref

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
2021.08.26-364-g6f9579c
1+
2021.08.26-378-g72f4b38

‎.github/workflows/ci.yml

+4
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,9 @@ jobs:
4646
run: |
4747
python .ci/scripts/check_requirements.py
4848
49+
docs:
50+
uses: "./.github/workflows/docs.yml"
51+
4952
lint:
5053
uses: "./.github/workflows/lint.yml"
5154

@@ -84,6 +87,7 @@ jobs:
8487
- "check-commits"
8588
- "lint"
8689
- "test"
90+
- "docs"
8791
if: "always()"
8892
steps:
8993
- name: "Collect needed jobs results"

‎.github/workflows/create-branch.yml

+7-8
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,20 @@ jobs:
2626
fetch-depth: 0
2727
path: "pulp_python"
2828

29+
- uses: "actions/checkout@v4"
30+
with:
31+
fetch-depth: 1
32+
repository: "pulp/plugin_template"
33+
path: "plugin_template"
34+
2935
- uses: "actions/setup-python@v5"
3036
with:
3137
python-version: "3.11"
3238

3339
- name: "Install python dependencies"
3440
run: |
3541
echo ::group::PYDEPS
36-
pip install bump2version jinja2 pyyaml packaging
42+
pip install bump2version packaging -r plugin_template/requirements.txt
3743
echo ::endgroup::
3844
3945
- name: "Setting secrets"
@@ -71,13 +77,6 @@ jobs:
7177
run: |
7278
find CHANGES -type f -regex ".*\.\(bugfix\|doc\|feature\|misc\|deprecation\|removal\)" -exec git rm {} +
7379
74-
- name: Checkout plugin template
75-
uses: actions/checkout@v4
76-
with:
77-
repository: pulp/plugin_template
78-
path: plugin_template
79-
fetch-depth: 0
80-
8180
- name: Update CI branches in template_config
8281
working-directory: plugin_template
8382
run: |

‎.github/workflows/docs.yml

+54
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# WARNING: DO NOT EDIT!
2+
#
3+
# This file was generated by plugin_template, and is managed by it. Please use
4+
# './plugin-template --github pulp_python' to update this file.
5+
#
6+
# For more info visit https://github.com/pulp/plugin_template
7+
8+
---
9+
name: "Docs"
10+
on:
11+
workflow_call:
12+
13+
jobs:
14+
test:
15+
if: "endsWith(github.base_ref, 'main')"
16+
runs-on: "ubuntu-20.04"
17+
defaults:
18+
run:
19+
working-directory: "pulp_python"
20+
steps:
21+
- uses: "actions/checkout@v4"
22+
with:
23+
fetch-depth: 1
24+
path: "pulp_python"
25+
- uses: "actions/setup-python@v5"
26+
with:
27+
python-version: "3.11"
28+
- name: "Setup cache key"
29+
run: |
30+
git ls-remote https://github.com/pulp/pulp-docs main | tee pulp-docs-main-sha
31+
- uses: "actions/cache@v4"
32+
with:
33+
path: "~/.cache/pip"
34+
key: ${{ runner.os }}-pip-${{ hashFiles('pulp-docs-main-sha') }}
35+
restore-keys: |
36+
${{ runner.os }}-pip-
37+
- name: "Install python dependencies"
38+
run: |
39+
echo ::group::PYDEPS
40+
pip install -r doc_requirements.txt
41+
echo ::endgroup::
42+
- name: "Build changelog"
43+
run: |
44+
towncrier build --yes --version 4.0.0.ci
45+
- name: "Build docs"
46+
run: |
47+
pulp-docs build
48+
49+
no-test:
50+
if: "!endsWith(github.base_ref, 'main')"
51+
runs-on: "ubuntu-20.04"
52+
steps:
53+
- run: |
54+
echo "Skip docs testing on non-main branches."

‎.github/workflows/scripts/before_install.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ fi
5757

5858
for i in {1..3}
5959
do
60-
ansible-galaxy collection install "amazon.aws:1.5.0" && s=0 && break || s=$? && sleep 3
60+
ansible-galaxy collection install "amazon.aws:8.1.0" && s=0 && break || s=$? && sleep 3
6161
done
6262
if [[ $s -gt 0 ]]
6363
then

‎.github/workflows/scripts/install.sh

+5-14
Original file line numberDiff line numberDiff line change
@@ -21,20 +21,13 @@ PLUGIN_SOURCE="./pulp_python/dist/pulp_python-${PLUGIN_VERSION}-py3-none-any.whl
2121
export PULP_API_ROOT="/pulp/"
2222

2323
PIP_REQUIREMENTS=("pulp-cli")
24-
if [[ "$TEST" = "docs" || "$TEST" = "publish" ]]
25-
then
26-
PIP_REQUIREMENTS+=("-r" "doc_requirements.txt")
27-
git clone https://github.com/pulp/pulpcore.git ../pulpcore
28-
PIP_REQUIREMENTS+=("psycopg2-binary" "-r" "../pulpcore/doc_requirements.txt")
29-
fi
3024

25+
# This must be the **only** call to "pip install" on the test runner.
3126
pip install ${PIP_REQUIREMENTS[*]}
3227

33-
if [[ "$TEST" != "docs" ]]
34-
then
35-
PULP_CLI_VERSION="$(pip freeze | sed -n -e 's/pulp-cli==//p')"
36-
git clone --depth 1 --branch "$PULP_CLI_VERSION" https://github.com/pulp/pulp-cli.git ../pulp-cli
37-
fi
28+
# Check out the pulp-cli branch matching the installed version.
29+
PULP_CLI_VERSION="$(pip freeze | sed -n -e 's/pulp-cli==//p')"
30+
git clone --depth 1 --branch "$PULP_CLI_VERSION" https://github.com/pulp/pulp-cli.git ../pulp-cli
3831

3932
cd .ci/ansible/
4033
if [ "$TEST" = "s3" ]; then
@@ -128,9 +121,7 @@ if [ "${PULP_API_ROOT:-}" ]; then
128121
fi
129122

130123
pulp config create --base-url https://pulp --api-root "$PULP_API_ROOT" --username "admin" --password "password"
131-
if [[ "$TEST" != "docs" ]]; then
132-
cp ~/.config/pulp/cli.toml "${REPO_ROOT}/../pulp-cli/tests/cli.toml"
133-
fi
124+
cp ~/.config/pulp/cli.toml "${REPO_ROOT}/../pulp-cli/tests/cli.toml"
134125

135126
ansible-playbook build_container.yaml
136127
ansible-playbook start_container.yaml

‎.github/workflows/scripts/script.sh

+1-9
Original file line numberDiff line numberDiff line change
@@ -18,22 +18,14 @@ source .github/workflows/scripts/utils.sh
1818
export POST_SCRIPT=$PWD/.github/workflows/scripts/post_script.sh
1919
export FUNC_TEST_SCRIPT=$PWD/.github/workflows/scripts/func_test_script.sh
2020

21-
# Needed for both starting the service and building the docs.
21+
# Needed for starting the service
2222
# Gets set in .github/settings.yml, but doesn't seem to inherited by
2323
# this script.
2424
export DJANGO_SETTINGS_MODULE=pulpcore.app.settings
2525
export PULP_SETTINGS=$PWD/.ci/ansible/settings/settings.py
2626

2727
export PULP_URL="https://pulp"
2828

29-
if [[ "$TEST" = "docs" ]]; then
30-
if [[ "$GITHUB_WORKFLOW" == "Python CI" ]]; then
31-
towncrier build --yes --version 4.0.0.ci
32-
fi
33-
pulp-docs build
34-
exit
35-
fi
36-
3729
REPORTED_STATUS="$(pulp status)"
3830

3931
echo "machine pulp

‎.github/workflows/test.yml

+1-2
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@ jobs:
2222
matrix:
2323
env:
2424
- TEST: pulp
25-
- TEST: docs
2625
- TEST: azure
2726
- TEST: s3
2827
- TEST: lowerbounds
@@ -72,7 +71,7 @@ jobs:
7271
- name: "Install python dependencies"
7372
run: |
7473
echo ::group::PYDEPS
75-
pip install towncrier twine wheel httpie docker netaddr boto3 ansible mkdocs jq jsonpatch
74+
pip install towncrier twine wheel httpie docker netaddr boto3 'ansible~=10.3.0' mkdocs jq jsonpatch
7675
echo "HTTPIE_CONFIG_DIR=$GITHUB_WORKSPACE/pulp_python/.ci/assets/httpie/" >> $GITHUB_ENV
7776
echo ::endgroup::
7877

‎.github/workflows/update_ci.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ jobs:
3636
- name: "Install python dependencies"
3737
run: |
3838
echo ::group::PYDEPS
39-
pip install gitpython requests packaging jinja2 pyyaml
39+
pip install gitpython packaging -r plugin_template/requirements.txt
4040
echo ::endgroup::
4141
4242
- name: "Configure Git with pulpbot name and email"

‎doc_requirements.txt

+6-14
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,8 @@
1-
build
2-
coreapi
3-
django
4-
djangorestframework
5-
django-filter
6-
drf-nested-routers
7-
mistune
8-
plantuml
9-
pyyaml
10-
sphinx
11-
sphinx-rtd-theme
12-
sphinxcontrib-openapi
1+
# WARNING: DO NOT EDIT!
2+
#
3+
# This file was generated by plugin_template, and is managed by it. Please use
4+
# './plugin-template --github pulp_python' to update this file.
5+
#
6+
# For more info visit https://github.com/pulp/plugin_template
137
towncrier
14-
twine
15-
# Unified docs
168
pulp-docs @ git+https://github.com/pulp/pulp-docs@main

‎template_config.yml

+1-5
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# This config represents the latest values used when running the plugin-template. Any settings that
22
# were not present before running plugin-template have been added with their default values.
33

4-
# generated with [email protected]364-g6f9579c
4+
# generated with [email protected]378-g72f4b38
55

66
api_root: /pulp/
77
black: false
@@ -12,21 +12,17 @@ check_stray_pulpcore_imports: true
1212
ci_base_image: ghcr.io/pulp/pulp-ci-centos9
1313
ci_env: {}
1414
ci_trigger: '{pull_request: {branches: [''*'']}}'
15-
ci_update_docs: false
1615
cli_package: pulp-cli
1716
cli_repo: https://github.com/pulp/pulp-cli.git
1817
core_import_allowed: []
1918
deploy_client_to_pypi: true
2019
deploy_client_to_rubygems: true
2120
deploy_to_pypi: true
2221
disabled_redis_runners: []
23-
doc_requirements_from_pulpcore: true
2422
docker_fixtures: false
25-
docs_test: true
2623
flake8: true
2724
flake8_ignore: []
2825
github_org: pulp
29-
issue_tracker: github
3026
latest_release_branch: '3.12'
3127
lint_requirements: true
3228
noissue_marker: '[noissue]'

0 commit comments

Comments
 (0)