Skip to content

Documentation: fix CI to catch untracked generated files#44642

Merged
joestringer merged 1 commit intocilium:mainfrom
MrHohn:fix-cmdref-ci-check
Mar 6, 2026
Merged

Documentation: fix CI to catch untracked generated files#44642
joestringer merged 1 commit intocilium:mainfrom
MrHohn:fix-cmdref-ci-check

Conversation

@MrHohn
Copy link
Copy Markdown
Contributor

@MrHohn MrHohn commented Mar 5, 2026

When new commands are added or new documentation is generated, the scripts in Documentation/ check for diffs using 'git diff --quiet'. However, this does not catch new, untracked files. This can lead to CI passing even if required documentation files are missing from the PR (but generated during the CI run).

This PR adds 'git add --intent-to-add' before the diff check to ensure new files are also considered.

Fixes #44636

@MrHohn MrHohn requested a review from a team as a code owner March 5, 2026 18:45
@MrHohn MrHohn requested a review from qmonnet March 5, 2026 18:45
@github-actions github-actions bot added the kind/community-contribution This was a contribution made by a community member. label Mar 5, 2026
@maintainer-s-little-helper maintainer-s-little-helper bot added the dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. label Mar 5, 2026
@joestringer joestringer added the release-note/ci This PR makes changes to the CI. label Mar 5, 2026
@maintainer-s-little-helper maintainer-s-little-helper bot removed the dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. label Mar 5, 2026
@HadrienPatte
Copy link
Copy Markdown
Member

/test

@joestringer joestringer enabled auto-merge March 5, 2026 21:21
When new commands are added or new documentation is generated, the
scripts in Documentation/ check for diffs using 'git diff --quiet'.
However, this does not catch new, untracked files. This can lead to CI
passing even if required documentation files are missing from the PR
(but generated during the CI run).

This PR adds 'git add --intent-to-add' before the diff check to ensure
new files are also considered.

Signed-off-by: Zihong Zheng <zihongz@google.com>
@joestringer joestringer force-pushed the fix-cmdref-ci-check branch from 3d7c556 to f48e4d6 Compare March 5, 2026 21:53
@joestringer
Copy link
Copy Markdown
Member

I rebased the PR because smoke tests were consistently failing, and I suspect it's because of a runtime conflict with a patch merged after the base commit of the PR. Re-triggering tests.

@joestringer
Copy link
Copy Markdown
Member

/test

@qmonnet
Copy link
Copy Markdown
Member

qmonnet commented Mar 6, 2026

/test

@maintainer-s-little-helper maintainer-s-little-helper bot added the ready-to-merge This PR has passed all tests and received consensus from code owners to merge. label Mar 6, 2026
@joestringer joestringer added this pull request to the merge queue Mar 6, 2026
Merged via the queue into cilium:main with commit bc8d757 Mar 6, 2026
76 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

kind/community-contribution This was a contribution made by a community member. ready-to-merge This PR has passed all tests and received consensus from code owners to merge. release-note/ci This PR makes changes to the CI.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

ci: missing Documentation/cmdref/cilium-dbg_policy_subject-selectors.md was not caught in #42580

4 participants