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

[ci] check all-jobs-succeed depends on all jobs #720

Merged
merged 6 commits into from
Dec 13, 2023
Merged

[ci] check all-jobs-succeed depends on all jobs #720

Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d22f439
[ci] check all-jobs-succeed depends on all jobs
tommy-gilligan Dec 13, 2023
d117f95
[ci] Print message when check-job-dependencies fails
tommy-gilligan Dec 13, 2023
377f932
[ci] Improve message for check-job-dependencies
tommy-gilligan Dec 13, 2023
136590e
[ci] Use less obscure line filter
tommy-gilligan Dec 13, 2023
30c39e0
[ci] Update comment to reflect change in code
tommy-gilligan Dec 13, 2023
5c4c65b
[ci] Be more specific on ignoring exit status
tommy-gilligan Dec 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
36 changes: 35 additions & 1 deletion .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -461,6 +461,40 @@ jobs:
cargo install --locked kani-verifier &> /dev/null || true
cargo kani setup &> /dev/null || true

check-job-dependencies:
runs-on: ubuntu-latest
name: Check all-jobs-succeeded depends on all jobs
steps:
- name: Install yq (for YAML parsing)
run: go install github.com/mikefarah/yq/v4@latest
- uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
- name: Run dependency check
run: |
set -eo pipefail
jobs=$(for i in $(find .github -iname '*.yaml' -or -iname '*.yml')
do
# Select jobs that are triggered by pull request.
if yq -e '.on | has("pull_request")' "$i" 2>/dev/null >/dev/null
then
# This gets the list of jobs that all-jobs-succeed does not depend on.
comm -23 \
<(yq -r '.jobs | keys | .[]' "$i" | sort | uniq) \
<(yq -r '.jobs.all-jobs-succeed.needs[]' "$i" | sort | uniq)
fi

# The sed call here excludes all-jobs-succeed from the list of jobs that
# all-jobs-succeed does not depend on. If all-jobs-succeed does
# not depend on itself, we do not care about it.
done | sort | uniq | sed '/^all-jobs-succeed$/d'
Copy link
Member

Choose a reason for hiding this comment

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

IMO more developers are familiar with grep -v than with sed with the /d suffix. It's also easier to look up since you can just look up the -v flag in the grep manpage (I tried looking up the /d suffix in the sed manpage and wasn't sure how to search for it).

Suggested change
done | sort | uniq | sed '/^all-jobs-succeed$/d'
done | sort | uniq | grep -v '^all-jobs-succeed$'

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The only trouble here is grep exits with 1 in this case. This is easy enough to ignore though.

)

if [ -n "$jobs" ]
then
missing_jobs="$(echo "$jobs" | tr ' ' '\n')"
echo "all-jobs-succeed missing dependencies on some jobs: $missing_jobs" | tee -a $GITHUB_STEP_SUMMARY
exit 1
fi

# Used to signal to branch protections that all other jobs have succeeded.
all-jobs-succeed:
name: All checks succeeded
Expand All @@ -471,7 +505,7 @@ jobs:
# https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/troubleshooting-required-status-checks#handling-skipped-but-required-checks
if: failure()
runs-on: ubuntu-latest
needs: [build_test, kani, check_fmt, check_readme, check_msrv, check_versions, generate_cache]
needs: [build_test, kani, check_fmt, check_readme, check_msrv, check_versions, generate_cache, check-job-dependencies]
steps:
- name: Mark the job as failed
run: exit 1