Autosquash Improvements #394
Closed
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
When the `--autosquash` command is used during a rebase, three prefixes can be used: - `fixup! ` - `squash! ` - `amend! ` See [the docs](https://git-scm.com/docs/git-rebase) here. The `no_fixup` config has been expanded to include all three options (this will need some comms to ensure no unexpended behaviour). Furthermore, an alias has been added under `no_autosquash`. Longer term, it may be worth considering replacing `no_fixup` with `no_autosquash`. Signed-off-by: JP-Ellis <josh@jpellis.me>
When autosquash commits are allowed, the prefix is removed before validating the rest of the commit (such as line length, conventional, etc.). Signed-off-by: JP-Ellis <josh@jpellis.me>
epage
reviewed
Sep 16, 2024
Comment on lines
+66
to
+67
| #[serde(alias = "fixup")] | ||
| Autosquash(Autosquash), |
There was a problem hiding this comment.
This is a breaking change. Our json output would be switching from emitting type = "fixup" messages to type = "autosquash".
|
This PR is listed as making 3 changes but it does so in 2 commits. Please be sure to make your commits atomic. The first two changes are different enough from the third, that really, this should be at least 2 PRs. |
epage
reviewed
Sep 16, 2024
Comment on lines
26
to
29
| if config.no_autosquash() { | ||
| failed |= check_autosquash(source, message, report)?; | ||
| failed |= autosquash_result; | ||
| } else if let Some(idx) = idx { | ||
| message = &message[idx..]; |
epage
reviewed
Sep 16, 2024
| Ok(true) | ||
| } else { | ||
| Ok(false) | ||
| ) -> Result<(bool, Option<usize>), anyhow::Error> { |
There was a problem hiding this comment.
Should we instead return the new message? We could use strip_prefix rather than starts_with.
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.
There are three main changes here:
fixup!to now includesquash!andamend!. This ensures better compliance with the Git docs in git-rebase.fixupwithautosquash. This was done both in the CLI and in the config. Eventually, it may be worth deprecatingfixupin favour ofautosquash; however, I am leaving that as a "future change".I understand that the change from "fixup" to "autosquash" might be a bit of a big change; however, this should be all backwards compatible. Happy to revise the PR if this is a step too far.
Resolves #392