Skip to content

docs: add CI overview and link from contributing guide#6406

Merged
khanhtc1202 merged 8 commits into
pipe-cd:masterfrom
Ayushmore1214:docs/ci-overview
Jan 13, 2026
Merged

docs: add CI overview and link from contributing guide#6406
khanhtc1202 merged 8 commits into
pipe-cd:masterfrom
Ayushmore1214:docs/ci-overview

Conversation

@Ayushmore1214
Copy link
Copy Markdown
Contributor

What this PR does: A doc for whole overview on Github Actions workflows , on when they trigger , and what it does for proper understanding for the new comers

Why we need it:

Which issue(s) this PR fixes:

Fixes #6401

Does this PR introduce a user-facing change?:

  • How are users affected by this change:
  • Is this breaking change:
  • How to migrate (if breaking change):

@Ayushmore1214 Ayushmore1214 requested a review from a team as a code owner January 7, 2026 00:49
Signed-off-by: Ayush More <ayushmore42595@gmail.com>
@Ayushmore1214
Copy link
Copy Markdown
Contributor Author

@khanhtc1202 drop your review

Comment thread CONTRIBUTING.md Outdated

All pull requests undergo checks by the continuous integration system, GitHub Actions. These checks include unit tests, lint tests, and more.

Before submitting a pull request, contributors are encouraged to understand
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.

We can write it in a more welcoming tone, such as:

When you submit a Pull Request to PipeCD, multiple CI workflows are triggered that validate your changes.

For an overview of all CI .... see:

Comment thread docs/content/en/docs-v1.0.x/development/ci.md Outdated
Removed unnecessary blank lines and improved document structure.

Signed-off-by: Ayush More <ayushmore42595@gmail.com>
Clarify the process and purpose of CI workflows for pull requests.

Signed-off-by: Ayush More <ayushmore42595@gmail.com>
@Ayushmore1214
Copy link
Copy Markdown
Contributor Author

Done




## References
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.

Were you trying to reference to these pages? If yes, the links are missing here.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Made the chnages !

Updated references section with new links.

Signed-off-by: Ayush More <ayushmore42595@gmail.com>
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread docs/content/en/docs-v1.0.x/development/ci.md Outdated
Comment thread docs/content/en/docs-v1.0.x/development/ci.md
Signed-off-by: Eeshaan Sawant <100678386+eeshaanSA@users.noreply.github.com>
Signed-off-by: Eeshaan Sawant <100678386+eeshaanSA@users.noreply.github.com>
@eeshaanSA
Copy link
Copy Markdown
Contributor

@Ayushmore1214, please fix the issues!

Signed-off-by: Ayush More <ayushmore42595@gmail.com>
Comment thread docs/content/en/docs-v1.0.x/development/ci.md Outdated
Signed-off-by: Eeshaan Sawant <100678386+eeshaanSA@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

@eeshaanSA eeshaanSA left a comment

Choose a reason for hiding this comment

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

Looks good, but please pay attention on the quality of commits you make from the next time. @Ayushmore1214.

Good quality commits = faster merge.
Low effort commits = delay in review. 😃

Copy link
Copy Markdown
Member

@khanhtc1202 khanhtc1202 left a comment

Choose a reason for hiding this comment

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

Good idea 👍

@khanhtc1202 khanhtc1202 enabled auto-merge (squash) January 13, 2026 08:22
@khanhtc1202 khanhtc1202 merged commit 832ab2c into pipe-cd:master Jan 13, 2026
42 checks passed
@github-actions github-actions Bot mentioned this pull request May 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: Add CI overview document explaining GitHub workflows

3 participants