Bidirectional Sync docs #7515
Open
Bidirectional Sync docs #7515
+42
−2
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
forstisabella
requested review from
stayseesong and
pwseg
and removed request for
stayseesong
✅ Deploy Preview for segment-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
pwseg
previously approved these changes
Mar 25, 2025
src/segment-app/extensions/git.md
Outdated
| @@ -84,6 +84,45 @@ To manage Segment resources using Git and Terraform, follow these steps: | |||
|
|
|||
| For more information on using Terraform, visit [Terraform's documentation](https://developer.hashicorp.com/terraform/docs){:target="_blank"}. | |||
|
|
|||
| ## Bidirectional Sync | |||
|
|
|||
| Bidirectional sync builds on top of the Git Sync extension and lets you manage your Segment workspace directly in GitHub. After you configure and enable bidirectional sync, Segment automatically listens for pull requests in your repository and manages all related workspace changes. Segment will not apply any changes unless the pull request has met all merge requirements and can be merged. | |||
There was a problem hiding this comment.
Could we tighten that last sentence to something like "Segment only applies changes from pull requests that meet all merge requirements"?
forstisabella
commented
Mar 25, 2025
Co-authored-by: pwseg <[email protected]>
deanhuynh
reviewed
Mar 25, 2025
|
|
||
| Bidirectional sync does not support variables, references to other resources, or resources from other providers. | ||
|
|
||
| > warning "Bidirectional sync can lead to broad workspace changes, including data loss" |
There was a problem hiding this comment.
Should this be rendered differently?
deanhuynh
reviewed
Mar 25, 2025
|
|
||
| 1. **Navigate to the Git Sync settings page to verify that your Git Sync integration is set up with Segment's GitHub App integration.** If it isn't, you can change the connection type under **Settings > Extensions > Git Sync > Manage Configuration**. If you were previously using the GitHub App integration, you might need to accept additional GitHub permissions that allow Segment to listen for the relevant events. | ||
| 2. **Add branch protection to your GitHub repository**. You can update your branch protections by opening GitHub and navigating to **Settings > Rules > Rulesets** and adding the Segment Extensions app to the **Bypass list**. | ||
| 3. **Navigate to the Segment app and enable Git sync bidirectional sync.** From the Segment app, navigate to **Settings > Extentions > Git Sync** page and enabling the **Git sync bidirectional sync** setting. |
There was a problem hiding this comment.
Suggested change
| 3. **Navigate to the Segment app and enable Git sync bidirectional sync.** From the Segment app, navigate to **Settings > Extentions > Git Sync** page and enabling the **Git sync bidirectional sync** setting. | |
| 3. **Navigate to the Segment app and enable Git sync bidirectional sync.** From the Segment app, navigate to **Settings > Extentions > Git Sync** page and enable the **Git sync bidirectional sync** setting. |
deanhuynh
reviewed
Mar 25, 2025
| Bidirectional sync builds on top of the Git Sync extension and lets you manage your Segment workspace directly in GitHub. After you configure and enable bidirectional sync, Segment automatically listens for pull requests in your repository and manages all related workspace changes. Segment only applies changes from pull requests that you successfully merge. | ||
|
|
||
| Bidirectional sync only supports: | ||
| - Explicit values (secrets require additional configuration) |
There was a problem hiding this comment.
Do we want to link to the secrets section here?
deanhuynh
reviewed
Mar 25, 2025
| @@ -84,6 +84,45 @@ To manage Segment resources using Git and Terraform, follow these steps: | |||
|
|
|||
| For more information on using Terraform, visit [Terraform's documentation](https://developer.hashicorp.com/terraform/docs){:target="_blank"}. | |||
|
|
|||
| ## Bidirectional Sync | |||
|
|
|||
| Bidirectional sync builds on top of the Git Sync extension and lets you manage your Segment workspace directly in GitHub. After you configure and enable bidirectional sync, Segment automatically listens for pull requests in your repository and manages all related workspace changes. Segment only applies changes from pull requests that you successfully merge. | |||
There was a problem hiding this comment.
Can we change the last sentence please? Segment won't apply changes that are merged, only those that the user explicitly accepts by commenting segment apply so might be a little bit misleading? The flow is as follows:
forstisabella
commented
Mar 25, 2025
| Bidirectional sync builds on top of the Git Sync extension and lets you manage your Segment workspace directly in GitHub. After you configure and enable bidirectional sync, Segment automatically listens for pull requests in your repository and manages all related workspace changes. Segment only applies changes from pull requests that you successfully merge. | ||
|
|
||
| Bidirectional sync only supports: | ||
| - Explicit values (secrets require additional configuration) |
There was a problem hiding this comment.
Suggested change
| - Explicit values (secrets require additional configuration) | |
| - Explicit values ([secrets](#use-secrets-with-bidirectional-sync) require additional configuration) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed changes
Added docs for the new bidirectional sync feature!
Merge timing
after approval from
Atitand DeanRelated issues (optional)