Repository navigation
docs: fix missing period in docs README - #7489
harshalsp07 wants to merge 6 commits into
Conversation
Signed-off-by: Harshal <[email protected]>
Signed-off-by: Harshal <[email protected]>
Signed-off-by: Harshal <[email protected]>
✅ Deploy Preview for pipecd-site canceled.
|
There was a problem hiding this comment.
🟡 Changes recommended
The required lint gate can pass when module discovery fails and Go linting never runs.
1 open finding
What changed in this PR
Adds a documentation punctuation fix and carries CI changes from #7486 to skip heavy jobs for docs-only pull requests.
Changes:
- Adds reusable documentation-change detection.
- Gates heavy CI jobs and adjusts completion checks.
- Adds the missing README period.
| File | Description |
|---|---|
| docs/README.md | Adds a final period. |
| .github/workflows/test.yaml | Gates tests on code changes. |
| .github/workflows/lint.yaml | Gates lint jobs and adjusts completion checks. |
| .github/workflows/gen.yaml | Gates code generation on code changes. |
| .github/workflows/changes.yaml | Adds reusable changed-path filtering. |
| .github/workflows/build.yaml | Gates builds on code changes. |
🧠 Review effort: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| runs-on: ubuntu-24.04 | ||
| if: always() | ||
| needs: go | ||
| needs: [changes, go] |
|
@harshalsp07 looks like you have pushed some unnecassary changes by mistake, plz revert them! |
|
Hi @Ayushmore1214 , actually I told him to create new PR to test the new workflow. Don't worry about that (Follow from PR #7486) Also thanks for your considering 😄 |
Signed-off-by: Harshal <[email protected]>
|
@armistcxy One thing though: since this PR also changes the workflow files, the filter will see non-docs changes and run everything, so it can't confirm the skip, correct me if I'm wrong and missing something here! |
|
@Ayushmore1214 I have not tried it yet, but stacked PRs can be applied to do this trick AFAIK |
Damnn, does it looks like I have to go more deeper on workflows! |
Signed-off-by: Harshal <[email protected]>
cf678d2 to
c053e5a
Compare
|
You're right @Ayushmore1214, the workflow files count as non-docs so everything runs and it can't show the skip as is. @armistcxy tried the stacked PR idea. This branch is now just the docs commit on top of the #7486 branch, so the diff here is docs-only. One catch: the workflows only trigger when the PR base matches master/release-v*/feat/, and the #7486 branch is named fix/... So if someone with push access can push that branch into pipe-cd under a feat/ name, I'll point this PR's base at it and the run should show the heavy jobs skipping. Or I can demo the same stack in my fork if a temp branch is too much hassle. |
What this PR does:
Fixes a missing period at the end of a sentence in
docs/README.md.This PR exists to verify #7486: it changes only a
.mdfile while carrying the workflow changes from that PR, so thetest,lint,build, andgenworkflows should skip their heavy jobs whilego-test-completedandgo-lint-completedpass. It will be closed once that's confirmed — please don't spend review time on it.Does this PR introduce a user-facing change?: