[Exercise Discussion] T6L2/merge-squash

[damithc]

Existing exercise check

• I have verified that this exercise is not yet already in discussion, in progress, or exists

Lesson

https://nus-cs2103-ay2526s1.github.io/website/book/gitAndGithub/merge/index.html (see detour: Doing a Squash Merge)

Exercise learning outcomes

Able to a squash merge

Exercise setup

Inputs to the new.sh:

Exercise name: merge-squash
Tags (space separated): git-branch git-merge git-reset
Requires Git? (defaults to y)  [y/N]: y
Requires Github? (defaults to y)  [y/N]: N
Exercise repo type (local, remote, or ignore) (defaults to 'local'): local
Exercise repo name (defaults to ...): friends-cast
Git-Mastery Github repository title (defaults to ''): 
Initialize exercise repo as Git repository? (defaults to y)  [y/N]: Y

Equivalent steps to popoulate the repo

echo -e "Matt LeBlanc" >> joey.txt
git add .
git commit -m "Add Joey"

echo -e "Lisa Kudrow" >> phoebe.txt
git add .
git commit -m "Add Phoebe"

git switch -c supporting
echo -e "Paul Rudd" >> mike.txt
git add .
git commit -m "Add Mike"

echo -e "Maggie Wheeler" >> janice.txt
git add .
git commit -m "Add Janice"

git switch main
echo -e "David Schwimmer" >> ross.txt
git add .
git commit -m "Add Ross"

Instructions for students

See https://git-mastery.github.io/lessons/merge/exercise-merge-squash.html

Exercise grading

Verify that, there is a new commit in the main branch containing the expected changes.

Requires remote repository?

No response

Additional remarks

No response

[woojiahao]

As another note, you don't need the first block of commands. Git-Mastery already handles creating the sub-folder titled play-characters based on the initial prompts. Would you want the sub-folder to be play-characters or friends-cast? You should update the prompt responses instead of running the commands

[woojiahao]

Apart from that, the rest LGTM!

[damithc]

@woojiahao Updated as suggested. Feel free to fix if I missed anything.

[oadultradeepfield]

Hi! The clarified setup and prompts look good. If no one’s working on this yet, could I be assigned to this issue? @damithc @woojiahao

[damithc]

@oadultradeepfield go ahead.

[oadultradeepfield]

@woojiahao @damithc While working on this issue, I found that the merge step in repo-smith only supports normal merges with or without fast-forwarding. However, there is currently no way to simulate a squash merge state. May I clarify if I missed something, or should I open an issue in repo-smith regarding this? Below is how I plan to implement it.

from dataclasses import dataclass
from git import Repo
from repo_smith.steps.step import Step


@dataclass
class MergeStep(Step):
    branch_name: str
    no_fast_forward: bool = False
    squash: bool = False

    def execute(self, repo: Repo) -> None:
        merge_args = [self.branch_name, "--no-edit"]

        if self.squash:
            merge_args.append("--squash")
        elif self.no_fast_forward:
            merge_args.append("--no-ff")

        repo.git.merge(*merge_args)

        if self.squash:
            repo.git.commit("-m", f"Squash merge branch '{self.branch_name}'")

For squash merges, we need to commit manually since --squash only stages the changes. Does this sound good?

[damithc]

@woojiahao @damithc While working on this issue, I found that the merge step in repo-smith only supports normal merges with or without fast-forwarding. However, there is currently no way to simulate a squash merge state. May I clarify if I missed something, or should I open an issue in repo-smith regarding this? Below is how I plan to implement it.

@woojiahao for your inputs ...