Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Update artifact handling #80

Merged
merged 19 commits into from
Feb 9, 2024
Merged

Update artifact handling #80

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
65d3371
Switch testplan handling in begin_report, append_report and generate_…
joernott Feb 5, 2024
59962f0
Update begin-report documentation
joernott Feb 5, 2024
9345e62
Remove separate logfile artifact handling in actions and switch to v4
joernott Feb 5, 2024
4e4af5f
Set unique coverage report artifact names
joernott Feb 5, 2024
c3f0b0e
Merge branch 'main' into update_artifact_handling
joernott Feb 5, 2024
d11ac3b
Switch action calls to v0
joernott Feb 6, 2024
fb2b032
Fix c/p error in begin_report
joernott Feb 6, 2024
645ddeb
Fix append_report
joernott Feb 6, 2024
6e496b1
Unique names in phpunit/codeception templates
joernott Feb 6, 2024
cdef7f1
Fix c/p error
joernott Feb 6, 2024
6aec033
Fix coverage artifact consolidation
joernott Feb 6, 2024
7c80602
Fix quote mess and dispatch inpots
joernott Feb 6, 2024
6d0443b
Fix coverage artifact consolidation
joernott Feb 6, 2024
15536ad
Fix pattern glob for coverage
joernott Feb 6, 2024
ea55ce9
Fix pattern glob for coverage
joernott Feb 6, 2024
ef91317
Improve cleanups
joernott Feb 6, 2024
fa8f9fa
Move clean to the end to give github some time to finish writing arti…
joernott Feb 6, 2024
65be382
Test delay before consolidating artifacts
joernott Feb 6, 2024
5c99ebe
Prepare for merge into release branch
joernott Feb 7, 2024
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
94 changes: 42 additions & 52 deletions .github/workflows/call-universal_test_workflow.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,31 +118,25 @@ jobs:
cp "${GITHUB_OUTPUT}" generated_output.txt
cp "${GITHUB_ENV}" generated_env.txt

- name: 'Upload generated test plan'
- name: 'Create testplan archive'
if: always()
uses: actions/upload-artifact@v3
uses: OXID-eSales/github-actions/begin_report@release-v4
with:
name: 'testplan'
path: |
title: ${{ steps.ltp.outputs.finish_slack_title }}
repository: '${{ github.server_url }}/${{ github.repository }}'
job: '${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}'
testplan: '${{ inputs.testplan }}'
files: |
${{ inputs.plan_folder}}/*
generated_testplan.yaml
generated_output.txt
generated_env.txt
load_testplan.log
retention-days: 7

- name: 'Write Report Header'
if: always()
uses: OXID-eSales/github-actions/begin_report@v3
with:
title: ${{ steps.ltp.outputs.finish_slack_title }}
repository: '${{ github.server_url }}/${{ github.repository }}'
job: '${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}'
testplan: '${{ inputs.testplan }}'

- name: 'Write Report'
if: always()
uses: OXID-eSales/github-actions/append_report@v3
uses: OXID-eSales/github-actions/append_report@release-v4
with:
header: true
phase: install
Expand Down Expand Up @@ -355,7 +349,7 @@ jobs:

- name: 'Write Report'
if: always()
uses: OXID-eSales/github-actions/append_report@v3
uses: OXID-eSales/github-actions/append_report@release-v4
with:
priority: '010'
phase: install
Expand Down Expand Up @@ -389,7 +383,7 @@ jobs:

- name: 'Install shop'
id: install_shop
uses: 'OXID-eSales/github-actions/install_shop@v3'
uses: 'OXID-eSales/github-actions/install_shop@release-v4'
with:
container_name: ${{ needs.init.outputs.install_shop_container_name }}
container_options: ${{ needs.init.outputs.install_shop_container_options }}
Expand Down Expand Up @@ -435,7 +429,7 @@ jobs:

- name: 'Write Report'
if: always()
uses: OXID-eSales/github-actions/append_report@v3
uses: OXID-eSales/github-actions/append_report@release-v4
with:
priority: '020'
phase: install
Expand Down Expand Up @@ -544,7 +538,7 @@ jobs:
- name: Install module
if: ${{ matrix.testplan != 'skip' }}
id: install_module
uses: 'OXID-eSales/github-actions/install_module@v3'
uses: 'OXID-eSales/github-actions/install_module@release-v4'
with:
container_name: ${{ steps.install_module_testplan.outputs.install_module_container_name }}
container_options: ${{ steps.install_module_testplan.outputs.install_module_container_options }}
Expand Down Expand Up @@ -590,7 +584,7 @@ jobs:

- name: 'Write Report'
if: ${{ always() && matrix.testplan != 'skip' }}
uses: OXID-eSales/github-actions/append_report@v3
uses: OXID-eSales/github-actions/append_report@release-v4
with:
priority: '030'
phase: install
Expand All @@ -604,7 +598,7 @@ jobs:

- name: 'Write Report'
if: ${{ always() && matrix.testplan == 'skip' }}
uses: OXID-eSales/github-actions/append_report@v3
uses: OXID-eSales/github-actions/append_report@release-v4
with:
priority: '030'
phase: install
Expand All @@ -621,7 +615,7 @@ jobs:
steps:
- name: 'Write Report'
if: always()
uses: OXID-eSales/github-actions/append_report@v3
uses: OXID-eSales/github-actions/append_report@release-v4
with:
header: true
priority: '100'
Expand Down Expand Up @@ -702,7 +696,7 @@ jobs:

- name: 'Run phpunit tests'
id: phpunit_run
uses: 'OXID-eSales/github-actions/phpunit@v3'
uses: 'OXID-eSales/github-actions/phpunit@release-v4'
with:
container_name: ${{ steps.phpunit_testplan.outputs.phpunit_container_name }}
container_options: ${{ steps.phpunit_testplan.outputs.phpunit_container_options }}
Expand All @@ -714,17 +708,17 @@ jobs:
logfile: ${{steps.phpunit_testplan.outputs.phpunit_logfile_prefix}}-${{ steps.phpunit_testplan.outputs.phpunit_title }}-${{steps.phpunit_testplan_name.outputs.matrix_suffix}}.txt
logfile_artifact: ${{ steps.phpunit_testplan.outputs.phpunit_logfile_artifact }}
output_files: ${{ steps.phpunit_testplan.outputs.phpunit_output_files }}
output_artifact: ${{steps.phpunit_testplan.outputs.phpunit_output_prefix}}_${{steps.phpunit_testplan_name.outputs.matrix_suffix}}
output_artifact: ${{steps.phpunit_testplan.outputs.phpunit_output_prefix}}-${{steps.phpunit_testplan_name.outputs.matrix_suffix}}
coverage_path: ${{ steps.phpunit_testplan.outputs.phpunit_coverage_path }}
coverage_artifact: ${{ steps.phpunit_testplan.outputs.phpunit_coverage_prefix }}_${{steps.phpunit_testplan_name.outputs.matrix_suffix}}
coverage_artifact: ${{ steps.phpunit_testplan.outputs.phpunit_coverage_prefix }}-${{steps.phpunit_testplan_name.outputs.matrix_suffix}}
failure_pattern: ${{ steps.phpunit_testplan.outputs.phpunit_failure_pattern }}

- name: 'Stop shop'
uses: 'OXID-eSales/github-actions/stop_shop@v3'

- name: 'Write Report'
if: always()
uses: OXID-eSales/github-actions/append_report@v3
uses: OXID-eSales/github-actions/append_report@release-v4
with:
priority: '110'
phase: test
Expand Down Expand Up @@ -862,7 +856,7 @@ jobs:

- name: 'Run codeception tests'
id: codeception_run
uses: 'OXID-eSales/github-actions/codeception@v3'
uses: 'OXID-eSales/github-actions/codeception@release-v4'
with:
container_name: ${{ steps.codeception_testplan.outputs.codeception_container_name }}
container_options: '${{ steps.codeception_testplan.outputs.codeception_container_options }} ${{ steps.pre_script.outputs.container_options }}'
Expand All @@ -877,17 +871,17 @@ jobs:
logfile: ${{steps.codeception_testplan.outputs.codeception_logfile_prefix}}-${{steps.codeception_testplan.outputs.codeception_title}}-${{steps.codeception_testplan_name.outputs.matrix_suffix}}.txt
logfile_artifact: ${{ steps.codeception_testplan.outputs.codeception_logfile_artifact }}
output_files: ${{ steps.codeception_testplan.outputs.codeception_output_files }}
output_artifact: ${{steps.codeception_testplan.outputs.codeception_output_prefix}}_${{steps.codeception_testplan_name.outputs.matrix_suffix}}
output_artifact: ${{steps.codeception_testplan.outputs.codeception_output_prefix}}-${{steps.codeception_testplan_name.outputs.matrix_suffix}}
coverage_path: ${{ steps.codeception_testplan.outputs.codeception_coverage_path }}
coverage_artifact: ${{ steps.codeception_testplan.outputs.codeception_coverage_prefix }}_${{steps.codeception_testplan_name.outputs.matrix_suffix}}
coverage_artifact: ${{ steps.codeception_testplan.outputs.codeception_coverage_prefix }}-${{steps.codeception_testplan_name.outputs.matrix_suffix}}
failure_pattern: ${{ steps.codeception_testplan.outputs.codeception_failure_pattern }}

- name: 'Stop shop'
uses: 'OXID-eSales/github-actions/stop_shop@v3'

- name: 'Write Report'
if: always()
uses: OXID-eSales/github-actions/append_report@v3
uses: OXID-eSales/github-actions/append_report@release-v4
with:
priority: '120'
phase: test
Expand Down Expand Up @@ -1026,7 +1020,7 @@ jobs:

- name: 'Run tests'
id: runtest_run
uses: 'OXID-eSales/github-actions/runtests@v3'
uses: 'OXID-eSales/github-actions/runtests@release-v4'
with:
container_name: ${{ steps.runtest_testplan.outputs.runtest_container_name }}
container_options: ${{ steps.runtest_testplan.outputs.runtest_container_options }}
Expand All @@ -1037,9 +1031,9 @@ jobs:
logfile: ${{ steps.runtest_testplan.outputs.runtest_logfile_prefix}}-${{ steps.runtest_testplan.outputs.runtest_title}}-${{ steps.runtest_testplan_name.outputs.matrix_suffix }}.txt
logfile_artifact: ${{ steps.runtest_testplan.outputs.runtest_logfile_artifact }}
output_files: ${{ steps.runtest_testplan.outputs.runtest_output_files }}
output_artifact: ${{ steps.runtest_testplan.outputs.runtest_output_prefix }}_${{ steps.runtest_testplan_name.outputs.matrix_suffix }}
output_artifact: ${{ steps.runtest_testplan.outputs.runtest_output_prefix }}-${{ steps.runtest_testplan_name.outputs.matrix_suffix }}
coverage_path: ${{ steps.runtest_testplan.outputs.runtest_coverage_path }}
coverage_artifact: ${{ steps.runtest_testplan.outputs.runtest_coverage_prefix }}_${{ steps.runtest_testplan_name.outputs.matrix_suffix }}
coverage_artifact: ${{ steps.runtest_testplan.outputs.runtest_coverage_prefix }}-${{ steps.runtest_testplan_name.outputs.matrix_suffix }}
failure_pattern: ${{ steps.runtest_testplan.outputs.runtest_failure_pattern }}
reset_shop: ${{ steps.runtest_testplan.outputs.runtest_reset_shop }}
reset_shop_binary: ${{ steps.runtest_testplan.outputs.runtest_reset_shop_binary }}
Expand All @@ -1050,7 +1044,7 @@ jobs:

- name: 'Write Report'
if: always()
uses: OXID-eSales/github-actions/append_report@v3
uses: OXID-eSales/github-actions/append_report@release-v4
with:
priority: '130'
phase: test
Expand All @@ -1067,7 +1061,7 @@ jobs:
steps:
- name: 'Write Report'
if: always()
uses: OXID-eSales/github-actions/append_report@v3
uses: OXID-eSales/github-actions/append_report@release-v4
with:
header: true
priority: '200'
Expand Down Expand Up @@ -1121,9 +1115,10 @@ jobs:
fetch-depth: 0

- name: 'SonarCloud Scan'
uses: 'OXID-eSales/github-actions/sonarcloud@v3'
uses: 'OXID-eSales/github-actions/sonarcloud@release-v4'
with:
coverage_artifact: coverage-reports_${{ steps.sonarcloud_testplan_name.outputs.matrix_suffix }}
coverage_artifact: 'coverage-reports-**-${{ steps.sonarcloud_testplan_name.outputs.matrix_suffix }}'
output_artifact: 'coverage-reports'
target_branch: ${{ steps.sonarcloud_testplan.outputs.sonarcloud_target_branch }}
strip_path: ${{ steps.sonarcloud_testplan.outputs.sonarcloud_strip_path }}
github_ref_name: ${{ github.ref_name }}
Expand All @@ -1136,7 +1131,7 @@ jobs:

- name: 'Write Report'
if: always()
uses: OXID-eSales/github-actions/append_report@v3
uses: OXID-eSales/github-actions/append_report@release-v4
with:
priority: '210'
phase: report
Expand Down Expand Up @@ -1171,7 +1166,7 @@ jobs:
docker_token: ${{ secrets.DOCKER_HUB_TOKEN }}

- name: 'Run phpcs tests'
uses: 'OXID-eSales/github-actions/phpcs@v3'
uses: 'OXID-eSales/github-actions/phpcs@release-v4'
with:
container_name: ${{ needs.init.outputs.phpcs_tests_container_name }}
container_options: ${{ needs.init.outputs.phpcs_tests_container_options }}
Expand All @@ -1189,7 +1184,7 @@ jobs:

- name: 'Write Report'
if: always()
uses: OXID-eSales/github-actions/append_report@v3
uses: OXID-eSales/github-actions/append_report@release-v4
with:
priority: '220'
phase: report
Expand Down Expand Up @@ -1267,7 +1262,7 @@ jobs:
container_method: 'exec'

- name: 'Run styles check'
uses: 'OXID-eSales/github-actions/styles@v3'
uses: 'OXID-eSales/github-actions/styles@release-v4'
with:
path: ${{ steps.styles_testplan.outputs.styles_path }}
module_ids: ${{ steps.styles_testplan.outputs.styles_module_ids }}
Expand All @@ -1283,7 +1278,7 @@ jobs:

- name: 'Write Report'
if: always()
uses: OXID-eSales/github-actions/append_report@v3
uses: OXID-eSales/github-actions/append_report@release-v4
with:
priority: '230'
phase: report
Expand Down Expand Up @@ -1311,7 +1306,7 @@ jobs:

- name: 'Write yamllint Report'
if: always()
uses: OXID-eSales/github-actions/append_report@v3
uses: OXID-eSales/github-actions/append_report@release-v4
with:
priority: '240'
phase: report
Expand Down Expand Up @@ -1358,7 +1353,7 @@ jobs:

- name: 'Write actionlint Report'
if: always()
uses: OXID-eSales/github-actions/append_report@v3
uses: OXID-eSales/github-actions/append_report@release-v4
with:
priority: '250'
phase: report
Expand Down Expand Up @@ -1388,22 +1383,17 @@ jobs:
env:
SLACK_WEBHOOK: "${{ secrets.SLACK_WEBHOOK_URL }}"
steps:
- name: 'Download job results'
uses: actions/download-artifact@v3
with:
name: testplan
- name: 'Wait a minute'
run: sleep 60

- name: 'Generate report'
id: generate_report
uses: 'OXID-eSales/github-actions/generate_report@v3'
uses: 'OXID-eSales/github-actions/generate_report@release-v4'
with:
slack_webhook: ${{ secrets.SLACK_WEBHOOK_URL }}
title: '${{ needs.init.outputs.finish_slack_title }}'

- name: Checkout the repo
uses: actions/checkout@v4

- name: 'clean_cache'
- name: 'Clean Cache'
if: ${{ steps.generate_report.outputs.overall_status == 'success' }}
uses: 'OXID-eSales/github-actions/clean_cache@v3'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

here it is v3

env:
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/dispatch-release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@ on:
description: 'Name of the feature branch, if empty, use the current branch'
default: ''
major:
type: number
type: string
required: true
description: 'Major version number (X.?.?)'
minor:
type: number
type: string
required: true
description: 'Minor version number (?.X.?)'
patch:
type: number
type: string
required: true
description: 'Patch version number (?.?.X)'
reviewer:
Expand Down
13 changes: 8 additions & 5 deletions append_report/action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,12 +69,12 @@ runs:
- name: 'Write summary'
if: ${{ inputs.header == 'false' }}
shell: bash
# yamllint disable rule:line-length
run: |
# append_report: Write summary
REPORT_FILE='reports/${{inputs.priority}}-${{inputs.phase}}-${{inputs.job}}-${{inputs.title}}-PHP${{inputs.php}}_MYSQL${{inputs.mysql}}.md'
STATUS_FILE='job_status/${{inputs.priority}}-${{inputs.phase}}-${{inputs.job}}-${{inputs.title}}-PHP${{inputs.php}}_MYSQL${{inputs.mysql}}.txt'
CACHE_FILE='caches/${{inputs.priority}}-${{inputs.phase}}-${{inputs.job}}-${{inputs.title}}-PHP${{inputs.php}}_MYSQL${{inputs.mysql}}.txt'
PLAN_FILE='generated_testplan-${{inputs.priority}}-${{inputs.phase}}-${{inputs.job}}-${{inputs.title}}-PHP${{inputs.php}}_MYSQL${{inputs.mysql}}.yaml'
SKIPPED_ICON='![Skipped](https://a.slack-edge.com/production-standard-emoji-assets/14.0/google-medium/26aa.png)'
SUCCESS_ICON='![Success](https://a.slack-edge.com/production-standard-emoji-assets/14.0/google-medium/2705.png)'
CANCELLED_ICON='![Cancelled](https://a.slack-edge.com/production-standard-emoji-assets/14.0/google-large/26ab.png)'
Expand All @@ -91,17 +91,20 @@ runs:
echo "|${{inputs.job}}|${{inputs.title}}|${{inputs.php}}|${{inputs.mysql}}|${TP}|${!JOB_ICON} ${JOB_STATUS}|" >"${REPORT_FILE}"
echo "${JOB_STATUS}" >"${STATUS_FILE}"
echo "${{inputs.cached_object}}" >"${CACHE_FILE}"
if [ -f 'generated_testplan.yaml' ]; then
mv generated_testplan.yaml "${PLAN_FILE}"
fi

- name: Upload Artifacts
# yamllint enable rule:line-length
if: always()
uses: actions/upload-artifact@v3
uses: actions/upload-artifact@v4
with:
name: testplan
name: 'testplan-${{inputs.priority}}-${{inputs.phase}}-${{inputs.job}}-${{inputs.title}}-PHP${{inputs.php}}_MYSQL${{inputs.mysql}}'
path: |
job_status/*.txt
reports/*.md
slack_reports/*.md
caches/*.txt
generated_testplan-*.yaml
if-no-files-found: ignore
retention-days: 7
retention-days: 2
Loading