To install or update git-branchless, run the following:

$ cargo install --locked git-branchless
$ git branchless init # in your repository

Release highlights

• The Apache and MIT license files are now distributed with all git-branchless sub-crates as required.
• Rust v1.74 or later is required to build.
• There are breaking changes to git hide and git sync; see below.
• Broken support for native Windows/Powershell due to bad hook invocations was probably fixed.
  • If this was affecting you, please comment on Running under PowerShell fails to invoke git in hooks #370 to confirm or refute.
• New merges() and branches() revset functions were introduced.

Changelog

See also the release notes for scm-record v0.3.0.

Added

• (feat(submit): add --dry-run flag #1129 ) Added a --dry-run option to git submit to report what would be submitted without actually doing so.
• (feat(revsets): add merges() and allow branches() to filter branch names #1130 ) Added merges() revset function.
• (feat(revsets): add merges() and allow branches() to filter branch names #1130 ) The branches() revset function now accepts an optional text pattern argument to limit which branches are matched.
• (feat(record): add --stash flag #1150 ) The git record command now accepts -s/--stash to return to the previous commit immediately after committing.
• ([1/16] feat(record): use commit message template in inline message editor #1167 ) The commit message for a new commit can now be written/edited during git record --interactive.
• (feat(record): allow multiple --message args #1169 ) git record now accepts multiple --message arguments.
• ([1/1] feat(submit:github): implement Github forge #1184 ) An initial Github forge was implemented as git submit --forge github, but it's too buggy for general use.
• (Add --exact flag to skip adding main and HEAD in smartlog #1241 ) git smartlog now accepts --exact to skip rendering HEAD and the main branch.
• (feat(submit): support multiple revset arguments #1244 ) git submit now accepts multiple arguments/revsets.

Changed

• BREAKING (feat(sync): resolve revset arguments to their entire stacks #1128 ) Arguments/revsets passed to git sync are now resolved to their respective stacks.
  • This allows git sync my-branch to work as expected, instead of needing to use git sync 'stack(my-branch)'. The behavior of git sync when called without arguments is not affected by this change. If you rely on the previous behavior, please use git move -x <commit(s)/revset> -d 'main()' instead.
• BREAKING (feat(hide): remove -D option from git hide #1152 ) Previously, git hide would not delete branches pointing to the hidden commits unless -D/--delete-branches was passed. Now, deleting branches is the default behavior. Pass --no-delete-branches to restore the old behavior.
• BREAKING ([1/2] feat(submit:github): disable Github forge detection by default #1292 ): The minimum supported Rust version (MSRV) is now 1.74.
• (fix(reword): Wrap rewording instructions to 72 chars #1204 ) The default instructions for git reword are now wrapped to 72 characters.
• ([1/2] feat(smartlog): switch from ⊘ to ◌ for synthetic omitted-commit nodes #1230 ) The icon for omitted commits in the smartlog was changed from ⊘ to ◌.

Fixed

• (cargo: add LICENSE file to each crate we publish #1071 ) The Apache and MIT licenses are now distributed with each constituent crate, not just the top-level git-branchless crate.
• (fix(amend): don't detach current branch when current commit has descendants #1072 ) The current branch is no longer detached during git amend when the current commit has descendants.
• (fix(amend): support amending merge commits #1073 ) Merge commits can now be amended with git amend.
• (fix(hooks): use same branchless dir for all worktrees #1095 ) The event log is now shared between all worktrees. Before, commits that were made in one worktree wouldn't be visible in other worktrees, etc.
• (fix(hooks): use same branchless dir for all worktrees #1095 ) git submit now runs in worktree that you invoked it in.
• (fix(hooks): use same branchless dir for all worktrees #1095 ) git submit --forge phabricator no longer records spurious commits when arc diffing.
• (fix(status): rudimentary support for filenames with spaces #1127 ) Improved support for files with spaces in their name.
• (fix(hooks): different PATH's name on windows and linux #1267 ) The correct "path" variable is now used on Windows, which fixes some cases of git-branchless failing on native Windows.

Contributors

Thanks to everyone who made this release happen!

• @adzenith made their first contribution in Fix release for new license files #1060
• @arxanas
• @avamsi made their first contribution in scm-diff-editor: fix typo for next item #1050
• @bryango made their first contribution in feat(nix): improve flake.nix, follows nixpkgs #1246
• @c00t made their first contribution in fix(hooks): different PATH's name on windows and linux #1267
• @claytonrcarter
• @jirutka made their first contribution in build: bump git2 from 0.17.2 to 0.18.3 #1285
• @martinvonz
• @mlcui-corp
• @snan made their first contribution in Change 'suggest' to 'discuss' #1126
• @willruggiano made their first contribution in chore: ignore direnv files #1254
• @YakoYakoYokuYoku made their first contribution in feat(record): add --stash flag #1150

If you're interested in contributing, check out the Developer Guide in the Wiki, or post in the Discussions or Discord server to ask any questions.