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.

Sign up for GitHub

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

Jump to bottom

docs: Add Mono Repo Usage #9556

Merged
merged 5 commits into from
May 29, 2023
Merged

docs: Add Mono Repo Usage #9556

merged 5 commits into from
May 29, 2023

Conversation

makdeniz
Copy link
Contributor

@makdeniz makdeniz commented Jun 1, 2022 •
edited

Signed-off-by: Murat Akdeniz makdeniz@msn.com

Note on DCO:

If the DCO action in the integration test fails, one or more of your commits are not signed off. Please click on the Details link next to the DCO action for instructions on how to resolve this.

Checklist:

  • Either (a) I've created an enhancement proposal and discussed it with the community, (b) this is a bug fix, or (c) this does not need to be in the release notes.
  • The title of the PR states what changed and the related issues number (used for the release note).
  • I've included "Closes [ISSUE #]" or "Fixes [ISSUE #]" in the description to automatically close the associated issue.
  • I've updated both the CLI and UI to expose my feature, or I plan to submit a second PR with them.
  • Does this PR require documentation updates?
  • I've updated documentation as required by this PR.
  • Optional. My organization is added to USERS.md.
  • I have signed off all my commits as required by DCO
  • I have written unit and/or e2e tests for my change. PRs without these are unlikely to be merged.
  • My build is green (troubleshooting builds).

@makdeniz makdeniz force-pushed the notifications-triggers-doc branch from 3714c67 to 1e061ee Compare June 1, 2022 16:14
@codecov
Copy link

codecov bot commented Jun 1, 2022 •
edited

Codecov Report

Patch and project coverage have no change.

Comparison is base (edf9916) 49.01% compared to head (b883188) 49.01%.

Additional details and impacted files 
@@           Coverage Diff           @@
##           master    #9556   +/-   ##
=======================================
  Coverage   49.01%   49.01%           
=======================================
  Files         247      247           
  Lines       42685    42685           
=======================================
  Hits        20924    20924           
  Misses      19645    19645           
  Partials     2116     2116

see 1 file with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

crenshaw-dev
crenshaw-dev requested changes Jun 2, 2022
View reviewed changes
Copy link
Collaborator

@crenshaw-dev crenshaw-dev left a comment

Choose a reason for hiding this comment

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

Thanks for the PR! Just requesting a tweak.

Can I get a second review from someone more familiar w/ notifications?

docs/operator-manual/notifications/triggers.md Outdated Show resolved Hide resolved
@makdeniz
doc:notifications triggers
7d11d9b 
Signed-off-by: Murat Akdeniz <makdeniz@msn.com>
@makdeniz
a small tweak
7f475b9 
Signed-off-by: Murat Akdeniz <makdeniz@msn.com>
@makdeniz makdeniz force-pushed the notifications-triggers-doc branch from 036e253 to 7f475b9 Compare June 2, 2022 18:53
@crenshaw-dev crenshaw-dev requested a review from alexmt June 6, 2022 14:48
@BeyondEvil
Copy link

This fixed the issue we were having with multiple applications in the same manifest repo.

When application A had changes, notifications were triggered for application B. Changing the oncePer as per this suggestion fixed it. 🙏

brunocascio
brunocascio reviewed Aug 23, 2022
View reviewed changes
docs/operator-manual/notifications/triggers.md
@@ -66,6 +65,10 @@ data:
send: [app-sync-succeeded]
```

**Mono Repo Usage**

When one repo is used to sync multiple applications, the `oncePer: app.status.sync.revision` field will trigger a notification for each commit. For mono repos, the better approach will be using `oncePer: app.status.operationState.syncResult.revision` statement. This way a notification will be sent only for a particular Application's revision.
Copy link

Choose a reason for hiding this comment

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

this save my life

@brunocascio
Copy link

This is helpful with applicationset-based repos where you attach annotations dynamically on every application and only the changed app should send the notification

@makdeniz makdeniz changed the title doc: notifications triggers docs: Add Mono Repo Usage Apr 24, 2023
@makdeniz
Copy link
Contributor Author

Hi @crenshaw-dev,
what is the process to continue with the PR?

@crenshaw-dev
Copy link
Collaborator

I'm not a notifications expert, but makes sense to me. Thanks @makdeniz!

@crenshaw-dev crenshaw-dev merged commit e4a7c2e into argoproj:master May 29, 2023
29 of 30 checks passed
yyzxw pushed a commit to yyzxw/argo-cd that referenced this pull request Aug 9, 2023
@makdeniz
docs: Add Mono Repo Usage (argoproj#9556)
c5cd2da 
* doc:notifications triggers

Signed-off-by: Murat Akdeniz <makdeniz@msn.com>

* a small tweak

Signed-off-by: Murat Akdeniz <makdeniz@msn.com>

---------

Signed-off-by: Murat Akdeniz <makdeniz@msn.com>
tesla59 pushed a commit to tesla59/argo-cd that referenced this pull request Dec 16, 2023
@makdeniz @tesla59
docs: Add Mono Repo Usage (argoproj#9556)
1842ced 
* doc:notifications triggers

Signed-off-by: Murat Akdeniz <makdeniz@msn.com>

* a small tweak

Signed-off-by: Murat Akdeniz <makdeniz@msn.com>

---------

Signed-off-by: Murat Akdeniz <makdeniz@msn.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@crenshaw-dev crenshaw-dev crenshaw-dev approved these changes

@alexmt alexmt Awaiting requested review from alexmt

@brunocascio brunocascio Awaiting requested review from brunocascio

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@makdeniz @BeyondEvil @brunocascio @crenshaw-dev