GitHub Workflows

This directory contains all Pulsar CI checks.

Required Workflows

When adding new CI workflows, please update the .asf.yaml if the workflow is required to pass before a PR can be merged. Instructions on how to update the file are below.

This project uses the .asf.yaml to configure which workflows are required to pass before a PR can be merged. In the .asf.yaml, the required contexts are defined in the github.protected_branches.*.required_status_checks.contexts.[] where * is any key in the protected_branches map.

You can view the currently required status checks by running the following command:

curl -s -H 'Accept: application/vnd.github.v3+json' https://api.github.com/repos/apache/pulsar/branches/master | \
jq .protection

These contexts get their names in one of two ways depending on how the workflow file is written in this directory. The following command will print out the names of each file and the associated with the check. If the name field is null, the context will be named by the id.

for f in .github/workflows/*.yaml; \
do FILE=$f yq eval -o j '.jobs | to_entries | {"file": env(FILE),"id":.[].key, "name":.[].value.name}' $f; \
done

Duplicate names are allowed, and all checks with the same name will be treated the same (required or not required).