[Discussion] Share tips, tricks and custom commands with Fork community #961

Lonli-Lokli · 2020-09-24T13:18:19Z

I believe with custom commands many of us have a plenty variety of ideas how to enrich usability.
Lets share it with each other!

Copy branch name to clipboard (thanks @DanPristupov )

DanPristupov · 2020-09-25T08:25:57Z

Thank you for starting this topic. A bit later I will add some useful examples and a short roadmap.

Otiel · 2020-10-09T13:54:48Z

Here are some I use:

  {
    "name": "Merge Commit Into Current Branch",
    "target": "revision",
    "action": {
      "type": "process",
      "path": "$git",
      "args": "merge $sha",
      "showOutput": false,
      "waitForExit": false
    }
  },
  {
    "name": "Rebase (Rebase Merges) to Here...",
    "target": "revision",
    "action": {
      "type": "process",
      "path": "$git",
      "args": "rebase --rebase-merges $SHA",
      "showOutput": false,
      "waitForExit": true
    }
  },
  {
    "name": "Rebase Interactively (Rebase Merges) to Here...",
    "target": "revision",
    "action": {
      "type": "process",
      "path": "$git",
      "args": "rebase --interactive --rebase-merges $SHA",
      "showOutput": false,
      "waitForExit": true
    }
  },
  {
    "name": "Copy Commit Abbreviated SHA",
    "target": "revision",
    "action": {
      "type": "process",
      "path": "$sh",
      "args": "-c 'echo $sha | clip'",
      "showOutput": false,
      "waitForExit": false
    }
  }

carlolars · 2020-11-02T18:03:08Z

Right-click on a commit in the log and do a "fixup!" commit of the staged changes:

  {
    "name": "Fixup! staged changes for '$sha'",
    "target": "revision",
    "action": {
      "type": "process",
      "path": "$git",
      "args": "commit --fixup $SHA",
      "showOutput": false,
      "waitForExit": false
    }
  },

jerone · 2020-12-07T14:19:25Z

Here is mine:

[
  {
    "name": "Change author to me",
    "target": "revision",
    "action": {
      "type": "process",
      "path": "$git",
      "args": "commit --amend --author \"John Doe <[email protected]>\" --no-edit",
      "showOutput": true,
      "waitForExit": true
    }
  },
  {
    "name": "Open in ConEmu",
    "target": "repository",
    "action": {
      "type": "process",
      "path": "C:\\Program Files\\ConEmu\\ConEmu64.exe",
      "args": "",
      "showOutput": false,
      "waitForExit": false
    }
  },
  {
    "name": "Open in Windows Terminal",
    "target": "repository",
    "action": {
      "type": "sh",
      "script": "wt -d \\\"$path\\\"",
      "showOutput": false,
      "waitForExit": false
    }
  },
  {
    "name": "Branches...",
    "target": "revision",
    "action": {
      "type": "sh",
      "script": "git branch -a --contains $SHA",
      "showOutput": true,
      "waitForExit": true
    }
  },
  {
    "name": "Find merge commit",
    "target": "revision",
    "action": {
      "type": "sh",
      "script": "git log --merges $SHA..",
      "showOutput": true,
      "waitForExit": true
    }
  }
]

dsbert · 2020-12-09T03:28:20Z

~~Unless I'm mistaken, most of these commands have been added into the application as standard features.~~

Mistaken

asontu · 2020-12-09T04:00:57Z

@dsbert No they have not, the devil is in the details:

rebase --rebase-merges != vanilla rebase
abbreviated sha != SHA

brhmira · 2021-01-13T13:44:29Z

Hi, I am using a custom command "git push -o merge_request.create ... etc.", the command itself automatically creates a merge request".
When running in cmd, there is a output message. For example: "Everything up-to-date". Unfortunately, I was not able to forward the git result message to Fork UI. When running a custom command, there is a window "Custom command completed", no details. Thx.

DanPristupov · 2021-01-13T14:10:45Z

@brhmira

This happens because "Everything up-to-date" is written to the stderr and the result window doesn't show error output by default. I need to think about how to handle this properly.

You can see the full output in the activity manager (the button in the left bottom corner in the status control on the toolbar).

tkolb-recom · 2021-02-02T10:46:47Z

  {
    "name": "Cherry-pick commit (append message)",
    "target": "revision",
    "ui": {
      "title": "Cherry-Pick",
      "description": "This will pick the selected commit to the current branch. Proceed?",
      "buttons": [
        {
          "title": "OK",
          "action": {
            "type": "process",
            "path": "$git",
            "args": "cherry-pick -x $SHA",
            "showOutput": true,
            "waitForExit": true
          }
        },
        {
          "title": "Cancel",
          "action": {
            "type": "cancel"
          }
        }
      ]
    }
  }

DrunkRussianGun · 2021-03-20T02:02:37Z

I'm actively using these, but they require aliases from here (except "Copy path" file command).

[
  {
    "name": "Fetch and rebase",
    "target": "ref",
    "refTargets": [
      "localbranch",
      "remotebranch"
    ],
    "action": {
      "type": "process",
      "path": "$git",
      "args": "febase $name",
      "showOutput": false,
      "waitForExit": true
    }
  },
  {
    "name": "Deliver",
    "target": "ref",
    "refTargets": [
      "localbranch",
      "remotebranch"
    ],
    "action": {
      "type": "process",
      "path": "$git",
      "args": "deliver $name",
      "showOutput": false,
      "waitForExit": true
    }
  },
  {
    "name": "Delete merged branches",
    "target": "ref",
    "refTargets": [
      "localbranch",
      "remotebranch"
    ],
    "action": {
      "type": "process",
      "path": "$git",
      "args": "del-merged $name",
      "showOutput": false,
      "waitForExit": true
    }
  },
  {
    "name": "Copy abbreviated commit SHA",
    "target": "revision",
    "action": {
      "type": "process",
      "path": "$git",
      "args": "cp-sha $SHA",
      "showOutput": false,
      "waitForExit": false
    }
  },
  {
    "name": "Copy commit full message",
    "target": "revision",
    "action": {
      "type": "process",
      "path": "$git",
      "args": "cp-message $SHA",
      "showOutput": false,
      "waitForExit": false
    }
  },
  {
    "name": "Reset files to here",
    "target": "revision",
    "action": {
      "type": "process",
      "path": "$git",
      "args": "reset-files $SHA",
      "showOutput": false,
      "waitForExit": true
    }
  },,
  {
    "name": "Fixup",
    "target": "revision",
    "action": {
      "type": "process",
      "path": "$git",
      "args": "fixup $SHA",
      "showOutput": false,
      "waitForExit": true
    }
  },
  {
    "name": "Copy path",
    "target": "file",
    "action": {
      "type": "process",
      "path": "$sh",
      "args": "-c 'echo \"$filepath\" | clip'",
      "showOutput": false,
      "waitForExit": false
    }
  }
]

decadence · 2021-04-06T14:55:22Z

Here is my 2 cents: make file executable for repository and git archive on selected commit.

{
    "name": "Make file executable",
    "target": "file",
    "action": {
      "type": "process",
      "path": "$git",
      "args": "update-index --chmod=+x $filepath",
      "showOutput": true,
      "waitForExit": true
    }
  },
{
  "name": "Make commit archive",
  "target": "revision",
  "action": {
    "type": "process",
    "path": "$git",
    "args": "archive --output=./$SHA.zip $SHA",
    "showOutput": true,
    "waitForExit": true
  }
}

Lonli-Lokli · 2021-06-22T16:01:51Z

Here is mine:

[
  {
    "name": "Change author to me",
    "target": "revision",
    "action": {
      "type": "process",
      "path": "$git",
      "args": "commit --amend --author \"John Doe <[email protected]>\" --no-edit",
      "showOutput": true,
      "waitForExit": true
    }
  }
]

I believe for change author it's better to use this
git -c user.name=“New Name" -c user.email=[email protected] commit --amend --reset-author --no-edit

jerone · 2021-06-22T20:45:39Z

I believe for change author it's better to use this
git -c user.name=“New Name" -c user.email=[email protected] commit --amend --reset-author --no-edit

@Lonli-Lokli Why is that better?

Lonli-Lokli · 2021-06-22T20:51:27Z

@jerone because original command will change the author to the name specified, but the committer will be set to your configured user in git config user.name and git config user.email.

I am still trying to understand what is the possible way to do it with some selected commits

kv1dr · 2021-06-30T06:56:33Z

Checkout only one file from specific commit:

[
  {
    "name": "Checkout file",
    "target": "file",
    "action": {
      "type": "process",
      "path": "$git",
      "args": "checkout -m $sha -- $filepath",
      "showOutput": false,
      "waitForExit": true
    }
  }
]

DanPristupov · 2021-06-30T08:40:09Z

@kv1dr right click on a file in the 'Changes' view -> Reset File to state at commit.

kv1dr · 2021-06-30T10:16:16Z

@kv1dr right click on a file in the 'Changes' view -> Reset File to state at commit.

Oh, I didn't know that option exists. But it's still missing from File Tree tab.

asontu · 2021-07-12T17:31:36Z

@Otiel how does your Rebase interactively with merges ever work? Since there's no GUI, every time I tried so far it has completely broken my Git into a corrupted state of half-rebase. Usually warrants restarting my machine to be able to manually remove rebase-folders under the .git folder.

Otiel · 2021-07-12T19:51:58Z

@asontu

Click on the custom command.
Edit git-rebase-todo in the opened editor.
Save git-rebase-todo / close the editor.
Fork should refresh and proceed with the rebase.

If you don't have an editor opening at step 2, that's probably because you're missing some config. If so, open the Shell from Fork (in order to modify the correct .gitconfig file), then run the following to use VS Code as editor:

git config --global core.editor "code --wait"

(see here for other common editors)

AndyWright-ct · 2022-01-12T15:57:43Z

If you have hub installed (https://github.com/github/hub)

Target: Repository
Name: Hub Sync
Type: Action
Action: Sh Command
	Script: hub sync
    [x] Wait for Exit
	[ ] Always Show Output -- up to you

This will remove merged branches and update all other branches, without you having to switch to the branch and pull -- a great time saver :)

BensonleeHC · 2022-04-25T06:28:00Z

Is there arg for previous SHA? thanks!!

Rossbro2 · 2022-05-18T16:41:11Z

I am still trying to understand what is the possible way to do it with some selected commits

Has anyone figured out how to change the author of a specific commit and not just head?

👀 @Lonli-Lokli

psylenced · 2022-05-20T10:00:11Z

Is there arg for previous SHA? thanks!!

You can use HEAD~1 (1 behind head) or 123456789~1 (1 behind sha 123456789).

So at a guess $sha~1 (maybe with a space) might work?

kapsiR · 2022-06-29T15:04:14Z

Nice file custom command to show the encoding of a file on Windows:

{
    "name": "file --mime-encoding",
    "target": "file",
    "action": {
      "type": "process",
      "path": "C:\\Program Files\\Git\\usr\\bin\\file.exe",
      "args": "--mime-encoding $filepath",
      "showOutput": true,
      "waitForExit": true
    }
  }

I'm not sure, if you have to install Git Bash to have file.exe available

jerone · 2022-09-21T11:13:09Z

@DanPristupov Would it be possible to support environment variable in paths:

%LocalAppData%\Microsoft\WindowsApps\wt.exe

Results in the following error:

I expect it to resolve to (which I know exists):

C:\Users\<username>\AppData\Local\Microsoft\WindowsApps\wt.exe

kapsiR · 2022-09-21T11:15:05Z

@jerone I created an issue for this some time ago, please upvote it with a reaction 😉

StephenHodgson · 2022-12-05T02:05:19Z

This comes in handy when I want to do either powershell or bash profiles. Love that it opens a tab for either.

  "ShellTool": {
    "Type": "Custom",
    "ApplicationPath": "%USERPROFILE%\\AppData\\Local\\Microsoft\\WindowsApps\\wt.exe",
    "Arguments": "new-tab -p \"PowerShell\" -d . ; new-tab -p \"Bash\" -d ."
  },

JeReT · 2022-12-20T14:46:51Z

We had the problem that we have a public version, a public hotfix version, where people already can preview upcoming fixes AND another public version for upcoming features. We are using gitflow and extract the version number from the latest tag.
The problem was that when we made a hotfix, it started from master were also the new features (release branches) are merged into. So we couldn't separate active major/minor and patch versions in git.

What I came up with was another branch next to develop and master and a script to finish a hotfix into that branch (and also the others). This way we can have a separation between hotfix and new feature versions.
Here is the script:

export LANG=C.UTF-8

cur=$(git branch --show-current)
version=$(basename $cur)

if [[ $cur == $name ]]
then
    echo You cannot finish $cur into itself.
    exit 1
fi

if [[ $cur == master || $cur == develop ]]
then
    echo finishing into master or develop is not allowed with this command.
    exit 1
fi

echo checking out master and merging
git checkout master
git merge --no-ff $cur

echo checking out develop and merging
git checkout develop
git merge --no-ff $cur

echo checking out $name, merging and create tag $version
git checkout $name
git merge --no-ff $cur

echo deleting branch
git branch -d $cur

#for some reason the script stops after tagging
echo creating tag
git tag -a $version -m "Merge branch $cur"

echo FINISHED

@DanPristupov
Do you have an idea why the command doesn't proceed after the tag creation command? e.g. echo FINISHED is never called / doesn't appear in the log.

EDIT:
found out how to properly share. Here also a version that doesn't merge into master and develop:

[
  {
    "name": "Finish here",
    "target": "ref",
    "refTargets": [
      "localbranch",
      "remotebranch"
    ],
    "action": {
      "type": "sh",
      "script": "export LANG=C.UTF-8\r\n\r\ncur=$(git branch --show-current)\r\nversion=$(basename $cur)\r\n\r\nif [[ $cur == $name ]]\r\nthen\r\n    echo You cannot finish $cur into itself.\r\n    exit 1\r\nfi\r\n\r\necho checking out $name and merging\r\ngit checkout $name\r\ngit merge --no-ff $cur\r\n\r\necho deleting branch\r\ngit branch -d $cur\r\n\r\n#for some reason the script stops after tagging\r\necho creating tag\r\ngit tag -a $version -m \"Merge branch $cur\"\r\n\r\necho FINISHED",
      "showOutput": false,
      "waitForExit": true
    }
  },
  {
    "name": "Finish here, master & develop",
    "target": "ref",
    "refTargets": [
      "localbranch",
      "remotebranch"
    ],
    "action": {
      "type": "sh",
      "script": "export LANG=C.UTF-8\r\n\r\ncur=$(git branch --show-current)\r\nversion=$(basename $cur)\r\n\r\nif [[ $cur == $name ]]\r\nthen\r\n    echo You cannot finish $cur into itself.\r\n    exit 1\r\nfi\r\n\r\nif [[ $cur == master || $cur == develop ]]\r\nthen\r\n    echo finishing into master or develop is not allowed with this command.\r\n    exit 1\r\nfi\r\n\r\necho checking out master and merging\r\ngit checkout master\r\ngit merge --no-ff $cur\r\n\r\necho checking out develop and merging\r\ngit checkout develop\r\ngit merge --no-ff $cur\r\n\r\necho checking out $name and merging\r\ngit checkout $name\r\ngit merge --no-ff $cur\r\n\r\necho deleting branch\r\ngit branch -d $cur\r\n\r\n#for some reason the script stops after tagging\r\necho creating tag\r\ngit tag -a $version -m \"Merge branch $cur\"\r\n\r\necho FINISHED",
      "showOutput": false,
      "waitForExit": true
    }
  }
]

ravindUwU · 2023-03-29T04:55:53Z

I use a custom command to git merge --ff-only (#95) 😊

{
	"name": "Merge (FF-only) into Current Branch",
	"target": "ref",
	"refTargets": [
		"localbranch"
	],
	"action": {
		"type": "process",
		"path": "$git",
		"args": "merge $name --ff-only",
		"showOutput": true,
		"waitForExit": true
	}
}

Just because I can't seem to find this documented anywhere (or perhaps missed it), %LocalAppData%\Fork\custom-commands.json stores custom commands' JSON representation.

palaniraja · 2023-07-31T23:25:06Z

Here is mine, Local PR without a commit so I can view consolidated changes
similar to the one above, but meets my need. No additional dialog, replicate same behavior as my PR rules and I can use better diff tools than the default bitbucket one.

{
    "action" : {
      "script" : "git merge ${ref} --no-ff --no-commit",
      "showOutput" : false,
      "type" : "sh",
      "waitForExit" : true
    },
    "name" : "Review Branch",
    "referenceTargets" : [
      "localBranch",
      "remoteBranch"
    ],
    "target" : "reference"
  }

havrlisan · 2023-10-14T14:04:08Z

I fell in love with the Lean Branching idea, but I'm too lazy to press the UI buttons Sync, Finish, and then checkout back to the working branch, so I created a command that does all of that on one click:

  {
    "action" : {
      "script" : "commits=$(git rev-list --count develop..${ref})\n\ngit stash save\ngit update-ref refs/heads/develop refs/remotes/origin/develop\ngit checkout develop\n\nif [ $commits == 1 ]; then\n  git merge ${ref}\nelse\n  git merge ${ref} --no-ff\nfi\n  \ngit push origin refs/heads/develop --verbose\ngit checkout ${ref}\ngit -c core.commentChar=^ rebase refs/heads/develop\ngit stash pop stash@{0}",
      "showOutput" : false,
      "type" : "sh",
      "waitForExit" : true
    },
    "name" : "Lean Branching - Rebase '${ref}' onto 'develop'",
    "refTargets" : [
      "localbranch"
    ],
    "target" : "ref"
  }

The command will also use merge --no-ff the same way as the Finish button does.

Edit: also added automatic stash save/pop.

DanPristupov pinned this issue Sep 25, 2020

DanPristupov mentioned this issue Sep 11, 2023

New feature: list the branches containing the selected commit in the commit tab #2010

Closed

arphox mentioned this issue Oct 6, 2023

$path / ${repo:path} custom command variable misses directory separators #2043

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Discussion] Share tips, tricks and custom commands with Fork community #961

[Discussion] Share tips, tricks and custom commands with Fork community #961

Lonli-Lokli commented Sep 24, 2020

DanPristupov commented Sep 25, 2020

Otiel commented Oct 9, 2020

carlolars commented Nov 2, 2020

jerone commented Dec 7, 2020 •

edited

Loading

dsbert commented Dec 9, 2020 •

edited

Loading

asontu commented Dec 9, 2020

brhmira commented Jan 13, 2021

DanPristupov commented Jan 13, 2021

tkolb-recom commented Feb 2, 2021

DrunkRussianGun commented Mar 20, 2021 •

edited

Loading

decadence commented Apr 6, 2021 •

edited

Loading

Lonli-Lokli commented Jun 22, 2021 •

edited

Loading

jerone commented Jun 22, 2021

Lonli-Lokli commented Jun 22, 2021 •

edited

Loading

kv1dr commented Jun 30, 2021

DanPristupov commented Jun 30, 2021

kv1dr commented Jun 30, 2021

asontu commented Jul 12, 2021

Otiel commented Jul 12, 2021 •

edited

Loading

AndyWright-ct commented Jan 12, 2022 •

edited

Loading

BensonleeHC commented Apr 25, 2022

Rossbro2 commented May 18, 2022

psylenced commented May 20, 2022

kapsiR commented Jun 29, 2022

jerone commented Sep 21, 2022

kapsiR commented Sep 21, 2022

StephenHodgson commented Dec 5, 2022

JeReT commented Dec 20, 2022 •

edited

Loading

ravindUwU commented Mar 29, 2023 •

edited

Loading

palaniraja commented Jul 31, 2023

havrlisan commented Oct 14, 2023 •

edited

Loading

[Discussion] Share tips, tricks and custom commands with Fork community #961

[Discussion] Share tips, tricks and custom commands with Fork community #961

Comments

Lonli-Lokli commented Sep 24, 2020

DanPristupov commented Sep 25, 2020

Otiel commented Oct 9, 2020

carlolars commented Nov 2, 2020

jerone commented Dec 7, 2020 • edited Loading

dsbert commented Dec 9, 2020 • edited Loading

asontu commented Dec 9, 2020

brhmira commented Jan 13, 2021

DanPristupov commented Jan 13, 2021

tkolb-recom commented Feb 2, 2021

DrunkRussianGun commented Mar 20, 2021 • edited Loading

decadence commented Apr 6, 2021 • edited Loading

Lonli-Lokli commented Jun 22, 2021 • edited Loading

jerone commented Jun 22, 2021

Lonli-Lokli commented Jun 22, 2021 • edited Loading

kv1dr commented Jun 30, 2021

DanPristupov commented Jun 30, 2021

kv1dr commented Jun 30, 2021

asontu commented Jul 12, 2021

Otiel commented Jul 12, 2021 • edited Loading

AndyWright-ct commented Jan 12, 2022 • edited Loading

BensonleeHC commented Apr 25, 2022

Rossbro2 commented May 18, 2022

psylenced commented May 20, 2022

kapsiR commented Jun 29, 2022

jerone commented Sep 21, 2022

kapsiR commented Sep 21, 2022

StephenHodgson commented Dec 5, 2022

JeReT commented Dec 20, 2022 • edited Loading

ravindUwU commented Mar 29, 2023 • edited Loading

palaniraja commented Jul 31, 2023

havrlisan commented Oct 14, 2023 • edited Loading

jerone commented Dec 7, 2020 •

edited

Loading

dsbert commented Dec 9, 2020 •

edited

Loading

DrunkRussianGun commented Mar 20, 2021 •

edited

Loading

decadence commented Apr 6, 2021 •

edited

Loading

Lonli-Lokli commented Jun 22, 2021 •

edited

Loading

Lonli-Lokli commented Jun 22, 2021 •

edited

Loading

Otiel commented Jul 12, 2021 •

edited

Loading

AndyWright-ct commented Jan 12, 2022 •

edited

Loading

JeReT commented Dec 20, 2022 •

edited

Loading

ravindUwU commented Mar 29, 2023 •

edited

Loading

havrlisan commented Oct 14, 2023 •

edited

Loading