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.

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

Skip pipeline jobs if only changing docs #2817

Open
sjberman opened this issue Nov 25, 2024 · 0 comments
Open

Skip pipeline jobs if only changing docs #2817

sjberman opened this issue Nov 25, 2024 · 0 comments
Labels
release-engineering Relates to all release engineering tasks
Milestone

Comments

@sjberman
Copy link
Contributor

sjberman commented Nov 25, 2024

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.
@sjberman sjberman added the release-engineering Relates to all release engineering tasks label Nov 25, 2024
@sjberman sjberman changed the title Skips pipeline jobs if only changing docs Skip pipeline jobs if only changing docs Nov 25, 2024
@mpstefan mpstefan modified the milestones: v2.0.0, v1.6.0 Nov 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release-engineering Relates to all release engineering tasks
Projects
Status: 🆕 New
Development

No branches or pull requests

2 participants