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

Clearification About GitOps Command Execution on Pushed Commits #1911

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

zakisk
Copy link
Contributor

@zakisk zakisk commented Feb 5, 2025

in docs it was not specified that GitOps command on pushed commit only works on latest HEAD commit and does not trigger PipelineRun if sent on older commits.

Changes

Submitter Checklist

  • 📝 Ensure your commit message is clear and informative. Refer to the How to write a git commit message guide. Include the commit message in the PR body rather than linking to an external site (e.g., Jira ticket).

  • ♽ Run make test lint before submitting a PR to avoid unnecessary CI processing. Consider installing pre-commit and running pre-commit install in the repository root for an efficient workflow.

  • ✨ We use linters to maintain clean and consistent code. Run make lint before submitting a PR. Some linters offer a --fix mode, executable with make fix-linters (ensure markdownlint and golangci-lint are installed).

  • 📖 Document any user-facing features or changes in behavior.

  • 🧪 While 100% coverage isn't required, we encourage unit tests for code changes where possible.

  • 🎁 If feasible, add an end-to-end test. See README for details.

  • 🔎 Address any CI test flakiness before merging, or provide a valid reason to bypass it (e.g., token rate limitations).

  • If adding a provider feature, fill in the following details:

Git Provider Supported
GitHub App ✅️
GitHub Webhook ❌️
Gitea ❌️
GitLab ❌️
Bitbucket Cloud ❌️
Bitbucket Server ❌️

(update the documentation accordingly)

@zakisk zakisk force-pushed the clearification-on-gitops-pushed-commit-head branch from 25865db to c53cd76 Compare February 6, 2025 03:28
@zakisk
Copy link
Contributor Author

zakisk commented Feb 6, 2025

/test

@@ -600,5 +600,5 @@ func (v *Provider) isBranchContainsCommit(ctx context.Context, runevent *info.Ev
if branchInfo.Commit.GetSHA() == runevent.SHA {
return nil
}
return fmt.Errorf("provided branch %s does not contains sha %s", branchName, runevent.SHA)
return fmt.Errorf("provided sha %s is not HEAD commit of branch %s", runevent.SHA, branchName)
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
return fmt.Errorf("provided sha %s is not HEAD commit of branch %s", runevent.SHA, branchName)
return fmt.Errorf("provided SHA %s is not the HEAD commit of the branch %s", runevent.SHA, branchName)

The changes:

  1. Capitalized "SHA" as it's an acronym
  2. Added "the" before "HEAD commit"
  3. Added "the" before "branch"

@chmouel
Copy link
Member

chmouel commented Feb 6, 2025

thanks, just a minor phrasing and good to go

@zakisk zakisk force-pushed the clearification-on-gitops-pushed-commit-head branch from c53cd76 to 5c72931 Compare February 6, 2025 14:14
@zakisk
Copy link
Contributor Author

zakisk commented Feb 6, 2025

/test go-testing

in docs it was not specified that GitOps command on pushed
commit only works on latest HEAD commit and does not trigger
PipelineRun if sent on older commits.

Signed-off-by: Zaki Shaikh <[email protected]>
@zakisk zakisk force-pushed the clearification-on-gitops-pushed-commit-head branch from 5c72931 to f9145ce Compare February 7, 2025 06:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants