Open
Conversation
The workspace commit message is quite old and a little out of date. Mainly we want to update the URL at the bottom, but I updated the general text of the message as well. Now it reads like this: ``` GitButler Workspace CommitTh This is is a merge commit of the virtual branches in your workspace. For GitButler to manage multiple parallel branches, we maintain this commit automatically so other tooling works properly. If you switch to another branch, GitButler will need to be reinitialized. Here are the branches that are currently applied: - clean-A branch head: d3cce74a69ee3b0e1cbea65b53908d602d6bda26 - conflict-C1 branch head: 6777bd8aff28a87a07739e2f309d3699d93685f9 - clean-B branch head: 115e41b0ffb7fcb56f91a9fb64cf4a7b786c1bea - For more information about what we're doing here, check out our docs: https://docs.gitbutler.com/workspace-branch ```
|
The latest updates on your projects. Learn more about Vercel for GitHub. 1 Skipped Deployment
|
github-actions
bot
added
rust
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the workspace commit message to modernize its text and correct the documentation URL. The old message emphasized limitations and warned users about potential data loss, while the new message has a more positive tone explaining that GitButler maintains the commit to ensure compatibility with other tooling.
Changes:
- Updated commit message text to explain GitButler maintains the workspace commit for tooling compatibility
- Removed the warning "If you commit on this branch, GitButler will throw it away"
- Updated documentation URL from
integration-branchtoworkspace-branch
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| crates/gitbutler-branch-actions/src/integration.rs | Updated workspace commit message text and documentation URL in legacy implementation |
| crates/but-workspace/src/commit/mod.rs | Updated workspace commit message text and documentation URL in new implementation |
| crates/but-workspace/tests/workspace/commit/mod.rs | Updated test snapshots to reflect new commit message and hashes |
| crates/but-workspace/tests/workspace/commit_engine/refs_update.rs | Updated test snapshot for new workspace commit hash |
| crates/but-workspace/tests/workspace/branch/apply_unapply_commit_uncommit.rs | Updated test snapshots for new workspace commit hashes |
| apps/desktop/src/components/ProjectSetupTarget.svelte | Updated documentation URL from integration-branch to workspace-branch |
| apps/desktop/src/components/NotOnGitButlerBranch.svelte | Updated documentation URL from integration-branch to workspace-branch |
| message.push_str("For more information about what we're doing here, check out our docs:\n"); | ||
| message.push_str("https://docs.gitbutler.com/features/branch-management/integration-branch\n"); | ||
| message.push_str("\nFor more information about what we're doing here, check out our docs:\n"); | ||
| message.push_str("https://docs.gitbutler.com/features/workspace-branch\n"); |
There was a problem hiding this comment.
URL inconsistency: This file uses https://docs.gitbutler.com/features/workspace-branch but the other implementation file (crates/but-workspace/src/commit/mod.rs line 552) and the frontend components use https://docs.gitbutler.com/workspace-branch (without /features/). These should be consistent to avoid broken links or confusion.
Suggested change
| message.push_str("https://docs.gitbutler.com/features/workspace-branch\n"); | |
| message.push_str("https://docs.gitbutler.com/workspace-branch\n"); |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
The workspace commit message is quite old and a little out of date.
Mainly we want to update the URL at the bottom, but I updated the
general text of the message as well. Now it reads like this: