-
Notifications
You must be signed in to change notification settings - Fork 114
132 lines (118 loc) Β· 5.48 KB
/
docs-parity-updates.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
name: Update Parity Docs
on:
schedule:
- cron: 0 5 * * MON
workflow_dispatch:
inputs:
targetBranch:
required: false
type: string
default: 'main'
jobs:
update-parity-coverage-docs:
name: Update Parity Docs
runs-on: ubuntu-latest
steps:
- name: Checkout docs
uses: actions/checkout@v4
with:
fetch-depth: 0
path: docs
ref: ${{ github.event.inputs.targetBranch || 'main' }}
- name: Set up system wide dependencies
run: |
sudo apt-get install jq wget
- name: Set up Python 3.11
id: setup-python
uses: actions/setup-python@v5
with:
python-version: "3.11"
- name: Setup Node
uses: actions/setup-node@v4
with:
node-version: '20'
- name: Download metrics data from Moto Integration test pipeline (GitHub)
working-directory: docs
run: ./scripts/get_latest_github_metrics.sh ./target main
env:
GITHUB_TOKEN: ${{ secrets.PRO_ACCESS_TOKEN }}
REPOSITORY_NAME: localstack-moto-test-coverage
ARTIFACT_ID: test-metrics
WORKFLOW: moto-integration-tests
PREFIX_ARTIFACT: moto-integration-test
FILTER_SUCCESS: 0
- name: Download metrics data from Terraform Integration test pipeline (GitHub)
working-directory: docs
run: ./scripts/get_latest_github_metrics.sh ./target main
env:
GITHUB_TOKEN: ${{ secrets.PRO_ACCESS_TOKEN }}
REPOSITORY_NAME: localstack-terraform-test
ARTIFACT_ID: test-metrics
WORKFLOW: "Terraform Tests"
FILTER_SUCCESS: 0
- name: Download metrics data from Pro pipeline (GitHub)
working-directory: docs
run: ./scripts/get_latest_github_metrics.sh ./target master
env:
GITHUB_TOKEN: ${{ secrets.PRO_ACCESS_TOKEN }}
REPOSITORY_NAME: localstack-ext
ARTIFACT_ID: parity-metric-ext-raw-*
WORKFLOW: "AWS / Build, Test, Push"
PREFIX_ARTIFACT: pro-integration-test
- name: Download coverage (capture-notimplemented) data from Pro pipeline (GitHub)
working-directory: docs
run: ./scripts/get_latest_github_metrics.sh ./target master
env:
GITHUB_TOKEN: ${{ secrets.PRO_ACCESS_TOKEN }}
REPOSITORY_NAME: localstack-ext
ARTIFACT_ID: capture-notimplemented-pro
WORKFLOW: "AWS / Build, Test, Push"
RESOURCE_FOLDER: "metrics-implementation-details"
- name: Download metrics data from latest Community test run (CircleCI)
working-directory: docs
env:
CIRCLE_CI_TOKEN: ${{ secrets.CIRCLE_CI_TOKEN }}
run: ./scripts/get_latest_circleci_metrics.sh ./target
- name: Create Parity Coverage Docs
working-directory: docs
run: |
python3 -m scripts.create_data_coverage -i target/metrics-implementation-details -r target/metrics-raw -o target/updated_coverage -s data/coverage/service_display_name.json
# Move the resulting markdown file to the docs repo
cp -r target/updated_coverage/md/* content/en/references/coverage && rm -R target/updated_coverage/md/
mv -f target/updated_coverage/data/*.json data/coverage
- name: Format Parity Coverage Docs
working-directory: docs
run: |
npm install
npm install markdownlint-cli2 --global
markdownlint-cli2 --config .markdownlint-cli2.yaml --fix
- name: Check for changes
id: check-for-changes
working-directory: docs
run: |
# Check if there are changed files and store the result in resources/diff-check.log
# Check against the PR branch if it exists, otherwise against the main
# Store the result in resources/diff-check.log and store the diff count in the GitHub Action output "diff-count"
mkdir -p resources
(git diff --name-only origin/parity-coverage-auto-updates content/en/references/ 2>/dev/null || git diff --name-only origin/${{ github.event.inputs.targetBranch || 'main' }} content/en/references/ 2>/dev/null) | tee resources/diff-check.log
(git diff --name-only origin/parity-coverage-auto-updates data/coverage/ 2>/dev/null || git diff --name-only origin/${{ github.event.inputs.targetBranch || 'main' }} data/coverage/ 2>/dev/null) | tee -a resources/diff-check.log
echo "diff-count=$(cat resources/diff-check.log | wc -l)" >> $GITHUB_OUTPUT
- name: Read PR markdown template
if: ${{ success() && steps.check-for-changes.outputs.diff-count != '0' && steps.check-for-changes.outputs.diff-count != '' }}
id: template
uses: juliangruber/read-file-action@v1
with:
path: docs/.github/bot_templates/PARITY_COVERAGE_DOCS_PR.md
- name: Create PR
uses: peter-evans/create-pull-request@v6
if: ${{ success() && steps.check-for-changes.outputs.diff-count != '0' && steps.check-for-changes.outputs.diff-count != '' }}
with:
path: docs
title: "Update Parity Coverage Docs"
body: "${{ steps.template.outputs.content }}"
branch: "parity-coverage-auto-updates"
author: "LocalStack Bot <[email protected]>"
committer: "LocalStack Bot <[email protected]>"
commit-message: "update generated parity coverage docs"
token: ${{ secrets.PRO_ACCESS_TOKEN }}
reviewers: steffyP