Skip to content

docs: update copy promotion step behaviour and configuration - #6809

Open
robinlioret wants to merge 1 commit into
akuity:mainfrom
robinlioret:docs/update-copy-step
Open

docs: update copy promotion step behaviour and configuration#6809
robinlioret wants to merge 1 commit into
akuity:mainfrom
robinlioret:docs/update-copy-step

Conversation

@robinlioret

Copy link
Copy Markdown

Description

This PR updates the "copy" promotion step documentation:

  • adds the "ignore" configuration option reference
  • adds more details about the behaviour of the step

Checklist

Eligibility

  • Linked to an existing issue with no blocking labels (kind/proposal, needs discussion, needs research, maintainer only, area/security, size/large, size/x-large, size/xx-large).
  • Changes documentation only.
  • Changes ten lines or fewer.

Quality

  • Adds or updates corresponding tests.
  • Adds or updates corresponding documentation.

AI Use Disclosure

This PR was written:

  • By a human without AI assistance.
  • By a human with AI assistance. A human has reviewed every line prior to opening the PR.
  • By an AI with human supervision. A human has reviewed every line prior to opening the PR.
  • Entirely by an AI. No human has reviewed this prior to opening the PR.

Sign-Off

All commits:

  • Are signed off by their author (git commit -s) (required)
  • Are cryptographically signed (git commit -S) (encouraged)

Signed-off-by: Robin Lioret <robin.lioret@seqone.com>
@robinlioret
robinlioret requested review from a team as code owners August 13, 2026 10:14
@netlify

netlify Bot commented Aug 13, 2026

Copy link
Copy Markdown

Deploy Preview for docs-kargo-io ready!

Name Link
🔨 Latest commit cf997b7
🔍 Latest deploy log https://app.netlify.com/projects/docs-kargo-io/deploys/6a7d990fe2e3240008c4f297
😎 Deploy Preview https://deploy-preview-6809.docs.kargo.io
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@kargo-governance-bot kargo-governance-bot Bot added needs/area Issue or PR needs to be labeled to indicate what parts of the code base are affected needs/kind Issue or PR needs to be labeled to clarify its nature needs/priority Priority has not yet been determined; a good signal that maintainers aren't fully committed labels Aug 13, 2026
Comment on lines +23 to +26
:::note
Symlinks encountered in the source are skipped, and `.git` directories are
always ignored, regardless of the `ignore` patterns.
:::

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

.gitdirectories are always ignored, regardless of theignore` patterns.

This isn't true. We even have a test for this that allows overriding default ignore rules that asserts a file in .git is included by using "!.git/"

https://github.com/akuity/kargo/blob/main/pkg/promotion/runner/builtin/file_copier_test.go#L302

So I would change that portion to something like:

".git is ignored by default but can be overridden by a user-supplied negation pattern"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

needs/area Issue or PR needs to be labeled to indicate what parts of the code base are affected needs/kind Issue or PR needs to be labeled to clarify its nature needs/priority Priority has not yet been determined; a good signal that maintainers aren't fully committed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants