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.

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

Introduce cms-squash-topic #125

Merged
merged 5 commits into from
Oct 19, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 0 additions & 7 deletions docs/man/man1/git-cms-rebase-topic.1
Original file line number Diff line number Diff line change
Expand Up @@ -70,13 +70,6 @@ Specify new base for merge-base or rebase (default = current branch).

Do not perform checkdeps at the end of the checkout.

.TP 5

-A, --all-deps

Perform checkdeps for all dependencies (header, python, BuildFile).
(Default: header, python.)

.SH DESCRIPTION

This is an alternate mode for git-cms-merge-topic.
Expand Down
78 changes: 78 additions & 0 deletions docs/man/man1/git-cms-squash-topic.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
.TH GIT_CMS_SQUASH_TOPIC 1 LOCAL

.SH NAME

git-cms-squash-topic - CMSSW helper to squash commits in a given branch.

.SH SYNOPSIS

.B git cms-squash-topic [[<github-user>:]{<branch>|<pull-request-id>}]

.SH OPTIONS

.TP 5

-d, --debug

Enable debug output.

.TP 5

--https

Access GitHub over https (default).

.TP 5

--ssh

Access GitHub over ssh.

.TP 5

--no-backup

Don't create a backup branch.

.TP 5

--backup-name

Specify suffix for backup branch (default = _backup).

.TP 5

-o, --old-base

Specify old base for merge-base or rebase (not used by default).

.TP 5

-u, --unsafe

Do not perform checkdeps at the end of the checkout.

.TP 5

--current

Squash the current branch. (implies --unsafe and --old-base $CMSSW_VERSION)

.TP 5

-m, --message

Specify new message for squashed commit (instead of using prepopulated message from original commits)

.SH DESCRIPTION

This is an alternate mode for git-cms-merge-topic.
It is useful to squash a PR branch if requested by the release manager
or if desired by the developer.

It can squash the current branch using the --current option.
If a remote branch is specified, git-cms-checkout-topic will automatically be performed for that branch.

To squash only a subset of the newest commits in a branch, change the --old-base value.
(Squashing intermediate commits, i.e. a subset that does not extend to the newest commits,
is not part of this tool; that operation requires the use of interactive rebase, i.e. git rebase -i.)
Loading