Skip to content

Skip pipeline jobs if only changing docs #2817

@sjberman

Description

@sjberman

When changing documentation in the NGF repo, we should not need to run all pipeline jobs. Only docs-related jobs should be run. This will speed up the process in changing docs and prevent unrelated failures from blocking these changes.

Even though test jobs are marked as required in Github, skipping these jobs in the workflow will still allow the PR to be merged.

We can use NIC as an example on how to skip jobs if only the docs are updated:
https://github.com/nginxinc/kubernetes-ingress/blob/main/.github/workflows/ci.yml#L60-L80
https://github.com/nginxinc/kubernetes-ingress/blob/main/.github/workflows/ci.yml#L37
https://github.com/nginxinc/kubernetes-ingress/blob/main/.github/workflows/ci.yml#L364

Acceptance

  • Changes to ONLY site or docs directories should skip all build and test jobs in the pipeline.
  • If changes to any other directory are detected, then all jobs should run.

Metadata

Metadata

Assignees

Labels

refinedRequirements are refined and the issue is ready to be implemented.release-engineeringRelates to all release engineering tasks

Type

No type

Projects

Status

✅ Done

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions