Skip to content

Commit c79c8d1

Browse files
rpbrittonrpbritton
authored
Merge branch 'main' into TO-238/exclude-archived-artefacts-filter
2 parents 515f113 + 9e26744 commit c79c8d1

30 files changed

+1143
-527
lines changed

‎.github/workflows/automatic-doc-checks.yml‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,17 @@
1+
#
12
name: Automatic doc checks
23

34
on:
45
push:
5-
branches-ignore:
6-
- 'main'
6+
branches: [ main ]
7+
pull_request:
78
paths:
8-
- 'docs/**'
9-
- '.github/workflows/automatic-doc-checks.yml'
9+
- 'docs/**' # Only run on changes to the docs directory
10+
- '.github/workflows/automatic-doc-checks.yml'
11+
1012
workflow_dispatch:
13+
# Manual trigger
14+
1115

1216
concurrency:
1317
group: ${{ github.workflow }}-${{ github.ref }}

‎.github/workflows/check-removed-urls.yml‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
name: Check for removed URLs
2+
3+
on:
4+
pull_request:
5+
branches: [main]
6+
7+
jobs:
8+
build-docs:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- name: Checkout PR branch
12+
uses: actions/checkout@v5
13+
with:
14+
# This implicitly gets the PR branch. Making it explicit causes problems
15+
# with private forks, but it is equivalent to the following:
16+
# repository: ${{ github.event.pull_request.head.repo.full_name }}
17+
# ref: ${{ github.event.pull_request.head.ref }}
18+
fetch-depth: 0
19+
path: compare
20+
- name: Checkout base branch
21+
uses: actions/checkout@v5
22+
with:
23+
ref: ${{ github.event.pull_request.base.ref }}
24+
repository: ${{ github.event.pull_request.base.repo.full_name }}
25+
fetch-depth: 0
26+
path: base
27+
- uses: actions/setup-python@v6
28+
- name: Build docs
29+
run: |
30+
for dir in compare base; do
31+
pushd ${dir}/docs
32+
make install
33+
. .sphinx/venv/bin/activate
34+
make html
35+
popd
36+
done
37+
- name: Generate current URLs list
38+
run: |
39+
for dir in compare base; do
40+
pushd ${dir}/docs
41+
find ./_build/ -name '*.html' \
42+
| sed 's|/_build||;s|/index.html$|/|;s|.html$||' \
43+
| sort > urls.txt
44+
popd
45+
done
46+
- name: Compare URLs
47+
run: |
48+
BASE_URLS_PATH="base/docs/urls.txt"
49+
COMPARE_URLS_PATH="compare/docs/urls.txt"
50+
removed=$(comm -23 ${BASE_URLS_PATH} ${COMPARE_URLS_PATH} )
51+
if [ -n "$removed" ]; then
52+
echo "The following URLs were removed:"
53+
echo "$removed"
54+
echo "Please ensure removed pages are redirected"
55+
exit 1
56+
fi

‎.github/workflows/cla-check.yml‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# This workflow checks if the contributor has signed the Canonical Contributor Licence Agreement (CLA)
2+
name: Canonical Contributor Licence Agreement check
3+
4+
on:
5+
pull_request:
6+
branches: [main]
7+
8+
jobs:
9+
cla-check:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- name: Check if CLA signed
13+
uses: canonical/has-signed-canonical-cla@v2

‎.github/workflows/markdown-style-checks.yml‎

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,26 @@ name: Markdown style checks
22

33
on:
44
push:
5-
branches-ignore:
6-
- 'main'
7-
workflow_dispatch:
8-
9-
concurrency:
10-
group: ${{ github.workflow }}-${{ github.ref }}
11-
cancel-in-progress: true
5+
branches:
6+
- main
7+
paths:
8+
- 'docs/**' # Only run on changes to the docs directory
9+
pull_request:
10+
branches:
11+
- '*'
12+
paths:
13+
- 'docs/**' # Only run on changes to the docs directory
1214

1315
jobs:
1416
markdown-lint:
1517
runs-on: ubuntu-22.04
1618
steps:
17-
- uses: actions/checkout@v4
19+
- uses: actions/checkout@v5
1820
with:
1921
fetch-depth: 0
20-
- uses: DavidAnson/markdownlint-cli2-action@v16
21-
with:
22-
config: "docs/.sphinx/.markdownlint.json"
22+
- name: Create venv
23+
working-directory: "docs"
24+
run: make install
25+
- name: Lint markdown
26+
working-directory: "docs"
27+
run: make lint-md

‎.github/workflows/sphinx-python-dependency-build-checks.yml‎

Lines changed: 0 additions & 52 deletions
This file was deleted.

‎.readthedocs.yaml‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,14 @@ build:
1111
tools:
1212
python: "3.11"
1313
jobs:
14-
pre_install:
15-
- git fetch --unshallow || true
1614
post_checkout:
15+
- git fetch --unshallow || true
1716
# Cancel building pull requests when there aren't changed in the docs directory.
1817
# If there are no changes (git diff exits with 0) we force the command to return with 183.
1918
# This is a special exit code on Read the Docs that will cancel the build immediately.
2019
# https://docs.readthedocs.io/en/stable/build-customization.html#cancel-build-based-on-a-condition
2120
- |
22-
if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/main -- docs/;
21+
if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/main -- 'docs/' '.readthedocs.yaml';
2322
then
2423
exit 183;
2524
fi
@@ -37,4 +36,4 @@ formats:
3736
# Optionally declare the Python requirements required to build your docs
3837
python:
3938
install:
40-
- requirements: docs/.sphinx/requirements.txt
39+
- requirements: docs/requirements.txt

‎backend/schemata/openapi.json‎

Lines changed: 98 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -239,61 +239,6 @@
239239
]
240240
}
241241
},
242-
"/v1/test-executions/{id}": {
243-
"patch": {
244-
"tags": [
245-
"test-executions"
246-
],
247-
"summary": "Patch Test Execution",
248-
"operationId": "patch_test_execution_v1_test_executions__id__patch",
249-
"parameters": [
250-
{
251-
"name": "id",
252-
"in": "path",
253-
"required": true,
254-
"schema": {
255-
"type": "integer",
256-
"title": "Id"
257-
}
258-
}
259-
],
260-
"requestBody": {
261-
"required": true,
262-
"content": {
263-
"application/json": {
264-
"schema": {
265-
"$ref": "#/components/schemas/TestExecutionsPatchRequest"
266-
}
267-
}
268-
}
269-
},
270-
"responses": {
271-
"200": {
272-
"description": "Successful Response",
273-
"content": {
274-
"application/json": {
275-
"schema": {
276-
"$ref": "#/components/schemas/TestExecutionResponse"
277-
}
278-
}
279-
}
280-
},
281-
"422": {
282-
"description": "Validation Error",
283-
"content": {
284-
"application/json": {
285-
"schema": {
286-
"$ref": "#/components/schemas/HTTPValidationError"
287-
}
288-
}
289-
}
290-
}
291-
},
292-
"x-permissions": [
293-
"change_test"
294-
]
295-
}
296-
},
297242
"/v1/test-executions/reruns": {
298243
"post": {
299244
"tags": [
@@ -753,6 +698,104 @@
753698
]
754699
}
755700
},
701+
"/v1/test-executions/{id}": {
702+
"get": {
703+
"tags": [
704+
"test-executions"
705+
],
706+
"summary": "Get Test Execution",
707+
"operationId": "get_test_execution_v1_test_executions__id__get",
708+
"parameters": [
709+
{
710+
"name": "id",
711+
"in": "path",
712+
"required": true,
713+
"schema": {
714+
"type": "integer",
715+
"title": "Id"
716+
}
717+
}
718+
],
719+
"responses": {
720+
"200": {
721+
"description": "Successful Response",
722+
"content": {
723+
"application/json": {
724+
"schema": {
725+
"$ref": "#/components/schemas/TestExecutionResponse"
726+
}
727+
}
728+
}
729+
},
730+
"422": {
731+
"description": "Validation Error",
732+
"content": {
733+
"application/json": {
734+
"schema": {
735+
"$ref": "#/components/schemas/HTTPValidationError"
736+
}
737+
}
738+
}
739+
}
740+
},
741+
"x-permissions": [
742+
"view_test"
743+
]
744+
},
745+
"patch": {
746+
"tags": [
747+
"test-executions"
748+
],
749+
"summary": "Patch Test Execution",
750+
"operationId": "patch_test_execution_v1_test_executions__id__patch",
751+
"parameters": [
752+
{
753+
"name": "id",
754+
"in": "path",
755+
"required": true,
756+
"schema": {
757+
"type": "integer",
758+
"title": "Id"
759+
}
760+
}
761+
],
762+
"requestBody": {
763+
"required": true,
764+
"content": {
765+
"application/json": {
766+
"schema": {
767+
"$ref": "#/components/schemas/TestExecutionsPatchRequest"
768+
}
769+
}
770+
}
771+
},
772+
"responses": {
773+
"200": {
774+
"description": "Successful Response",
775+
"content": {
776+
"application/json": {
777+
"schema": {
778+
"$ref": "#/components/schemas/TestExecutionResponse"
779+
}
780+
}
781+
}
782+
},
783+
"422": {
784+
"description": "Validation Error",
785+
"content": {
786+
"application/json": {
787+
"schema": {
788+
"$ref": "#/components/schemas/HTTPValidationError"
789+
}
790+
}
791+
}
792+
}
793+
},
794+
"x-permissions": [
795+
"change_test"
796+
]
797+
}
798+
},
756799
"/v1/artefacts": {
757800
"get": {
758801
"tags": [

0 commit comments

Comments
 (0)