Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 8 additions & 0 deletions .github/workflows/verify-reusable.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,19 @@ jobs:
steps:
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
fetch-depth: 0
persist-credentials: false
- run: |
if [ -n "${{ github.base_ref }}" ]; then
git fetch origin "${{ github.base_ref }}:${{ github.base_ref }}"
fi
- run: make generate update
- run: make staticcheck
- run: make fmt
- run: make vet
- run: make verify-api-deps
- run: make verify-crd-schema
- run: make verify-docs-nav

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Would it be easier to ensure that all the verify steps run consistently in all environments if they were wrapped in a single execution target/script? e.g. I would expect there to be a single make verify that does every run element in this list so that there's no chance of future additions to the verification flow becoming mismatched in local/PR/prow execution flows

- run: |
git update-index --refresh
git diff-index --cached --quiet --ignore-submodules HEAD --
Expand Down
6 changes: 5 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The following guidelines will help ensure a smooth contribution process for both

3. **Review before submitting**: Look at your changes from a reviewer's perspective and explain anything that might not be immediately clear in your PR description.

4. **Use proper commit format**:
4. **Use proper commit format**:
1. Write commit subjects in [imperative mood](https://en.wikipedia.org/wiki/Imperative_mood) (e.g., "Fix bug" not "Fixed bug")
2. Follow [conventional commit format](https://www.conventionalcommits.org/) and include "Why" and "How" in commit messages

Expand All @@ -34,6 +34,10 @@ The following guidelines will help ensure a smooth contribution process for both

This project uses [Prow](https://docs.ci.openshift.org/) and [GitHub Actions](https://github.com/openshift/hypershift/actions) for CI. Lightweight checks (linting, unit tests, verification) run automatically on pushes and pull requests. E2E tests that consume real cloud infrastructure only run after a reviewer grants `/lgtm`, to avoid unnecessary resource usage on work-in-progress PRs.

**Adding CI targets:** When you add a new `make` target to `verify-parallel` or any other CI-facing Makefile target, you must also add it to the corresponding GitHub Actions workflow (e.g., `.github/workflows/verify-reusable.yaml` for verify targets, or as a new "reusable" target). GitHub Actions provide fast feedback on PRs; Prow runs heavier e2e tests. Targets that only exist in the Makefile without a matching GH Actions step will not run in CI.

See hack/github-actions-runner/README.md for details.

Useful Prow commands:

- `/test <job-name>` - Run a specific CI job
Expand Down
2 changes: 1 addition & 1 deletion docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -106,12 +106,12 @@ nav:
- 'CI Pipeline Configuration': how-to/ci/v2-testing/ci-pipeline.md
- 'Debugging CI Failures': how-to/ci/v2-testing/debugging.md
- 'Migrating from V1': how-to/ci/v2-testing/migration.md
- 'Cluster Capabilities': how-to/cluster-capabilities.md
- 'Common':
- how-to/common/exposing-services-from-hcp.md
- 'Global Pull Secret': how-to/common/global-pull-secret.md
- 'HCP Networking Requirements': how-to/common/hcp-networking-requirements.md
- how-to/common/multi-arch-on-hcp.md
- 'Cluster Capabilities': how-to/cluster-capabilities.md
- how-to/metrics-sets.md
- 'Configure OCP components':
- how-to/configure-ocp-components/index.md
Expand Down