chore: fix function name and comment #424
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Generate testing docs | |
on: | |
workflow_call: | |
pull_request: | |
merge_group: | |
push: | |
branches: | |
- main | |
- release/v* | |
- feat/* | |
permissions: | |
contents: write | |
pull-requests: write # 'write' access to pull requests in order to update test documentation automatically | |
jobs: | |
testing-docs: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout repository | |
uses: actions/checkout@v4 | |
- uses: actions/setup-go@v5 | |
with: | |
go-version: "1.22" | |
check-latest: true | |
cache: true | |
cache-dependency-path: go.sum | |
- uses: technote-space/[email protected] | |
id: git_diff | |
with: | |
PATTERNS: | | |
tests/integration/**/*.go | |
**/Makefile | |
Makefile | |
- name: Generate testing docs | |
if: env.GIT_DIFF | |
run: make build-testing-docs | |
- name: Check for changes and update automatically | |
if: env.GIT_DIFF | |
id: check_changes_and_update | |
run: | | |
git show HEAD:scripts/test_doc/test_documentation.md > committed_file.md | |
cp scripts/test_doc/test_documentation.md generated_file.md | |
if ! diff -q generated_file.md committed_file.md; then | |
echo "Documentation for integration tests is out of date. Updating and pushing changes..." | |
cp generated_file.md scripts/test_doc/test_documentation.md | |
if [ -n "$GITHUB_HEAD_REF" ]; then | |
branch=$GITHUB_HEAD_REF | |
else | |
branch=${GITHUB_REF#refs/heads/} | |
fi | |
git fetch origin $branch | |
git checkout $branch | |
cp generated_file.md scripts/test_doc/test_documentation.md | |
git config user.name "github-actions" | |
git config user.email "[email protected]" | |
git add scripts/test_doc/test_documentation.md | |
git commit -m "Update testing documentation" | |
git push origin "$branch" | |
fi |