Skip to content

Commit ce53351

Browse files
david22swandavid22swan
authored
Merge pull request #1115 from puppetlabs/CONT-751-Implement_reusable_workflows
(CONT-752) - Implement reusable workflows
2 parents 28927a7 + bad5015 commit ce53351

File tree

6 files changed

+41
-640
lines changed

6 files changed

+41
-640
lines changed

‎.github/workflows/auto_release.yml‎

Lines changed: 4 additions & 84 deletions
Original file line numberDiff line numberDiff line change
@@ -3,88 +3,8 @@ name: "Auto release"
33
on:
44
workflow_dispatch:
55

6-
env:
7-
HONEYCOMB_WRITEKEY: 7f3c63a70eecc61d635917de46bea4e6
8-
HONEYCOMB_DATASET: litmus tests
9-
CHANGELOG_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
10-
116
jobs:
12-
auto_release:
13-
name: "Automatic release prep"
14-
runs-on: ubuntu-20.04
15-
16-
steps:
17-
18-
- name: "Honeycomb: Start recording"
19-
uses: puppetlabs/kvrhdn-gha-buildevents@pdk-templates-v1
20-
with:
21-
apikey: ${{ env.HONEYCOMB_WRITEKEY }}
22-
dataset: ${{ env.HONEYCOMB_DATASET }}
23-
job-status: ${{ job.status }}
24-
25-
- name: "Honeycomb: start first step"
26-
run: |
27-
echo STEP_ID="auto-release" >> $GITHUB_ENV
28-
echo STEP_START=$(date +%s) >> $GITHUB_ENV
29-
- name: "Checkout Source"
30-
if: ${{ github.repository_owner == 'puppetlabs' }}
31-
uses: actions/checkout@v2
32-
with:
33-
fetch-depth: 0
34-
persist-credentials: false
35-
36-
- name: "PDK Release prep"
37-
uses: docker://puppet/iac_release:ci
38-
with:
39-
args: 'release prep --force'
40-
env:
41-
CHANGELOG_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
42-
43-
- name: "Get Version"
44-
if: ${{ github.repository_owner == 'puppetlabs' }}
45-
id: gv
46-
run: |
47-
echo "::set-output name=ver::$(jq --raw-output .version metadata.json)"
48-
49-
- name: "Check if a release is necessary"
50-
if: ${{ github.repository_owner == 'puppetlabs' }}
51-
id: check
52-
run: |
53-
git diff --quiet CHANGELOG.md && echo "::set-output name=release::false" || echo "::set-output name=release::true"
54-
55-
- name: "Commit changes"
56-
if: ${{ github.repository_owner == 'puppetlabs' && steps.check.outputs.release == 'true' }}
57-
run: |
58-
git config --local user.email "${{ github.repository_owner }}@users.noreply.github.com"
59-
git config --local user.name "GitHub Action"
60-
git add .
61-
git commit -m "Release prep v${{ steps.gv.outputs.ver }}"
62-
63-
- name: Create Pull Request
64-
id: cpr
65-
uses: puppetlabs/peter-evans-create-pull-request@v3
66-
if: ${{ github.repository_owner == 'puppetlabs' && steps.check.outputs.release == 'true' }}
67-
with:
68-
token: ${{ secrets.GITHUB_TOKEN }}
69-
commit-message: "Release prep v${{ steps.gv.outputs.ver }}"
70-
branch: "release-prep"
71-
delete-branch: true
72-
title: "Release prep v${{ steps.gv.outputs.ver }}"
73-
body: |
74-
Automated release-prep through [pdk-templates](https://github.com/puppetlabs/pdk-templates/blob/main/moduleroot/.github/workflows/auto_release.yml.erb) from commit ${{ github.sha }}.
75-
Please verify before merging:
76-
- [ ] last [nightly](https://github.com/${{ github.repository }}/actions/workflows/nightly.yml) run is green
77-
- [ ] [Changelog](https://github.com/${{ github.repository }}/blob/release-prep/CHANGELOG.md) is readable and has no unlabeled pull requests
78-
- [ ] Ensure the [changelog](https://github.com/${{ github.repository }}/blob/release-prep/CHANGELOG.md) version and [metadata](https://github.com/${{ github.repository }}/blob/release-prep/metadata.json) version match
79-
labels: "maintenance"
80-
81-
- name: PR outputs
82-
if: ${{ github.repository_owner == 'puppetlabs' && steps.check.outputs.release == 'true' }}
83-
run: |
84-
echo "Pull Request Number - ${{ steps.cpr.outputs.pull-request-number }}"
85-
echo "Pull Request URL - ${{ steps.cpr.outputs.pull-request-url }}"
86-
87-
- name: "Honeycomb: Record finish step"
88-
if: ${{ always() }}
89-
run: |
90-
buildevents step $TRACE_ID $STEP_ID $STEP_START 'Finished auto release workflow'
7+
release_prep:
8+
name: "Release Prep"
9+
uses: "puppetlabs/cat-github-actions/.github/workflows/module_release_prep.yml@main"
10+
secrets: "inherit"

‎.github/workflows/ci.yml‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: "ci"
2+
3+
on:
4+
pull_request:
5+
branches:
6+
- "main"
7+
workflow_dispatch:
8+
9+
jobs:
10+
Spec:
11+
uses: "puppetlabs/cat-github-actions/.github/workflows/module_ci.yml@main"
12+
with:
13+
runs_on: "ubuntu-20.04"
14+
secrets: "inherit"
15+
16+
Acceptance:
17+
needs: Spec
18+
uses: "puppetlabs/cat-github-actions/.github/workflows/module_acceptance.yml@main"
19+
with:
20+
runs_on: "ubuntu-20.04"
21+
secrets: "inherit"

‎.github/workflows/nightly.yml‎

Lines changed: 12 additions & 200 deletions
Original file line numberDiff line numberDiff line change
@@ -2,208 +2,20 @@ name: "nightly"
22

33
on:
44
schedule:
5-
- cron: '0 0 * * *'
6-
7-
env:
8-
HONEYCOMB_WRITEKEY: 7f3c63a70eecc61d635917de46bea4e6
9-
HONEYCOMB_DATASET: litmus tests
5+
- cron: "0 0 * * *"
6+
workflow_dispatch:
107

118
jobs:
12-
setup_matrix:
13-
name: "Setup Test Matrix"
14-
runs-on: ubuntu-20.04
15-
outputs:
16-
matrix: ${{ steps.get-matrix.outputs.matrix }}
17-
18-
steps:
19-
- name: "Honeycomb: Start recording"
20-
uses: puppetlabs/kvrhdn-gha-buildevents@pdk-templates-v1
21-
with:
22-
apikey: ${{ env.HONEYCOMB_WRITEKEY }}
23-
dataset: ${{ env.HONEYCOMB_DATASET }}
24-
job-status: ${{ job.status }}
25-
26-
- name: "Honeycomb: Start first step"
27-
run: |
28-
echo STEP_ID=setup-environment >> $GITHUB_ENV
29-
echo STEP_START=$(date +%s) >> $GITHUB_ENV
30-
31-
- name: Checkout Source
32-
uses: actions/checkout@v2
33-
if: ${{ github.repository_owner == 'puppetlabs' }}
34-
35-
- name: Activate Ruby 2.7
36-
uses: ruby/setup-ruby@v1
37-
if: ${{ github.repository_owner == 'puppetlabs' }}
38-
with:
39-
ruby-version: "2.7"
40-
bundler-cache: true
41-
42-
- name: Print bundle environment
43-
if: ${{ github.repository_owner == 'puppetlabs' }}
44-
run: |
45-
echo ::group::bundler environment
46-
buildevents cmd $TRACE_ID $STEP_ID 'bundle env' -- bundle env
47-
echo ::endgroup::
48-
49-
- name: "Honeycomb: Record Setup Environment time"
50-
if: ${{ github.repository_owner == 'puppetlabs' }}
51-
run: |
52-
buildevents step $TRACE_ID $STEP_ID $STEP_START 'Setup Environment'
53-
echo STEP_ID=Setup-Acceptance-Test-Matrix >> $GITHUB_ENV
54-
echo STEP_START=$(date +%s) >> $GITHUB_ENV
55-
56-
- name: Setup Acceptance Test Matrix
57-
id: get-matrix
58-
if: ${{ github.repository_owner == 'puppetlabs' }}
59-
run: |
60-
if [ '${{ github.repository_owner }}' == 'puppetlabs' ]; then
61-
buildevents cmd $TRACE_ID $STEP_ID matrix_from_metadata -- bundle exec matrix_from_metadata_v2
62-
else
63-
echo "::set-output name=matrix::{}"
64-
fi
65-
66-
- name: "Honeycomb: Record Setup Test Matrix time"
67-
if: ${{ always() }}
68-
run: |
69-
buildevents step $TRACE_ID $STEP_ID $STEP_START 'Setup Test Matrix'
9+
Spec:
10+
uses: "puppetlabs/cat-github-actions/.github/workflows/module_ci.yml@main"
11+
with:
12+
runs_on: "ubuntu-20.04"
13+
secrets: "inherit"
7014

7115
Acceptance:
72-
name: "${{matrix.platforms.label}}, ${{matrix.collection}}"
73-
needs:
74-
- setup_matrix
75-
76-
runs-on: ubuntu-20.04
77-
strategy:
78-
fail-fast: false
79-
matrix: ${{fromJson(needs.setup_matrix.outputs.matrix)}}
80-
81-
env:
82-
BUILDEVENT_FILE: '../buildevents.txt'
83-
84-
steps:
85-
- run: |
86-
echo 'platform=${{ matrix.platforms.image }}' >> $BUILDEVENT_FILE
87-
echo 'collection=${{ matrix.collection }}' >> $BUILDEVENT_FILE
88-
echo 'label=${{ matrix.platforms.label }}' >> $BUILDEVENT_FILE
89-
90-
91-
- name: "Honeycomb: Start recording"
92-
uses: puppetlabs/kvrhdn-gha-buildevents@pdk-templates-v1
93-
with:
94-
apikey: ${{ env.HONEYCOMB_WRITEKEY }}
95-
dataset: ${{ env.HONEYCOMB_DATASET }}
96-
job-status: ${{ job.status }}
97-
matrix-key: ${{ matrix.platforms.label }}-${{ matrix.collection }}
98-
99-
- name: "Honeycomb: start first step"
100-
run: |
101-
echo STEP_ID=${{ matrix.platforms.image }}-${{ matrix.collection }}-1 >> $GITHUB_ENV
102-
echo STEP_START=$(date +%s) >> $GITHUB_ENV
103-
104-
- name: Checkout Source
105-
uses: actions/checkout@v2
106-
107-
- name: Activate Ruby 2.7
108-
uses: ruby/setup-ruby@v1
109-
with:
110-
ruby-version: "2.7"
111-
bundler-cache: true
112-
113-
- name: Print bundle environment
114-
run: |
115-
echo ::group::bundler environment
116-
buildevents cmd $TRACE_ID $STEP_ID 'bundle env' -- bundle env
117-
echo ::endgroup::
118-
119-
- name: "Honeycomb: Record Setup Environment time"
120-
if: ${{ always() }}
121-
run: |
122-
buildevents step $TRACE_ID $STEP_ID $STEP_START 'Setup Environment'
123-
echo STEP_ID=${{ matrix.platforms.image }}-${{ matrix.collection }}-2 >> $GITHUB_ENV
124-
echo STEP_START=$(date +%s) >> $GITHUB_ENV
125-
126-
- name: Provision test environment
127-
run: |
128-
if [[ "${{matrix.platforms.provider}}" == "provision::docker" ]]; then
129-
DOCKER_RUN_OPTS="docker_run_opts: {'--volume': '/lib/modules/$(uname -r):/lib/modules/$(uname -r)'}"
130-
else
131-
DOCKER_RUN_OPTS=''
132-
fi
133-
buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:provision ${{ matrix.platforms.image }}' -- bundle exec rake "litmus:provision[${{matrix.platforms.provider}},${{ matrix.platforms.image }},$DOCKER_RUN_OPTS]"
134-
echo ::group::=== REQUEST ===
135-
cat request.json || true
136-
echo
137-
echo ::endgroup::
138-
echo ::group::=== INVENTORY ===
139-
if [ -f 'spec/fixtures/litmus_inventory.yaml' ];
140-
then
141-
FILE='spec/fixtures/litmus_inventory.yaml'
142-
elif [ -f 'inventory.yaml' ];
143-
then
144-
FILE='inventory.yaml'
145-
fi
146-
sed -e 's/password: .*/password: "[redacted]"/' < $FILE || true
147-
echo ::endgroup::
148-
149-
- name: Install agent
150-
run: |
151-
buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:install_agent ${{ matrix.collection }}' -- bundle exec rake 'litmus:install_agent[${{ matrix.collection }}]'
152-
153-
- name: Install module
154-
run: |
155-
buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:install_module' -- bundle exec rake 'litmus:install_module'
156-
157-
- name: "Honeycomb: Record deployment times"
158-
if: ${{ always() }}
159-
run: |
160-
echo ::group::honeycomb step
161-
buildevents step $TRACE_ID $STEP_ID $STEP_START 'Deploy test system'
162-
echo STEP_ID=${{ matrix.platforms.image }}-${{ matrix.collection }}-3 >> $GITHUB_ENV
163-
echo STEP_START=$(date +%s) >> $GITHUB_ENV
164-
echo ::endgroup::
165-
166-
- name: Run acceptance tests
167-
run: |
168-
buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:acceptance:parallel' -- bundle exec rake 'litmus:acceptance:parallel'
169-
170-
- name: "Honeycomb: Record acceptance testing times"
171-
if: ${{ always() }}
172-
run: |
173-
buildevents step $TRACE_ID $STEP_ID $STEP_START 'Run acceptance tests'
174-
echo STEP_ID=${{ matrix.platforms.image }}-${{ matrix.collection }}-4 >> $GITHUB_ENV
175-
echo STEP_START=$(date +%s) >> $GITHUB_ENV
176-
177-
- name: Remove test environment
178-
if: ${{ always() }}
179-
continue-on-error: true
180-
run: |
181-
if [[ -f inventory.yaml || -f spec/fixtures/litmus_inventory.yaml ]]; then
182-
buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:tear_down' -- bundle exec rake 'litmus:tear_down'
183-
echo ::group::=== REQUEST ===
184-
cat request.json || true
185-
echo
186-
echo ::endgroup::
187-
fi
188-
189-
- name: "Honeycomb: Record removal times"
190-
if: ${{ always() }}
191-
run: |
192-
buildevents step $TRACE_ID $STEP_ID $STEP_START 'Remove test environment'
16+
needs: Spec
17+
uses: "puppetlabs/cat-github-actions/.github/workflows/module_acceptance.yml@main"
18+
with:
19+
runs_on: "ubuntu-20.04"
20+
secrets: "inherit"
19321

194-
slack-workflow-status:
195-
if: always()
196-
name: Post Workflow Status To Slack
197-
needs:
198-
- Acceptance
199-
runs-on: ubuntu-20.04
200-
steps:
201-
- name: Slack Workflow Notification
202-
uses: puppetlabs/Gamesight-slack-workflow-status@pdk-templates-v1
203-
with:
204-
# Required Input
205-
repo_token: ${{ secrets.GITHUB_TOKEN }}
206-
slack_webhook_url: ${{ secrets.SLACK_WEBHOOK }}
207-
# Optional Input
208-
channel: '#team-ia-bots'
209-
name: 'GABot'

0 commit comments

Comments
 (0)