The last part of my script is to prevent a commit taking place if the branch name is incorrect. This prefixes the issue number in square brackets to the start of the commit message. with open(commit_msg_filepath, 'r+') as fh: Then we write this to the start of the temporary commit message file that we determined from the hook parameters. If the branch name is correct we grab the issue number from it. Once we’ve got the current branch name we want to check that it is in the expected format using a regular expression. branch = check_output().strip() Determining the Issue Number We use Python’s check_output method to run this command and capture its return value.
This can be retrieved by using the command git symbolic-ref -short HEAD. We also need the branch name to check that it is using the correct format for our workflow and to determine the issue number. We want to grab the first parameter so that we can prefix the default commit message before the editor loads. the temporary file for the commit message.prepare-commit-msg has three parameters we can use:. We can get this file path from one of the hook parameters that Git will pass to our script. Git creates this file so that we can edit the commit message within an editor before finally committing the changes to the repository. One of the first things we need to do is determine the temporary file Git is going to use to write the commit message to. Getting the Temporary Commit Message File and Branch Name Let’s take a look at what’s going on in this script. With open(commit_msg_filepath, 'r+') as fh:įh.write(' %s' % (issue, commit_msg))Įlif branch != 'master' and branch != 'dev': #!/usr/bin/env pythonīranch = check_output().strip() This can be done with chmod from the command line. It’s important to ensure that this file is executable otherwise it won’t run on git commit. We’re going to use Python to script our desired functionality here and need to create the file prepare-commit-msg in our repository’s. This hook is invoked by git commit it is called straight after receiving the default commit message but before the editor is loaded so we can set up our message ready for editing before finally committing changes to a repository. In order to modify the commit messages we need to work with the prepare-commit-msg hook. We’re going to utilise a Git hook to check a branch name and automatically prefix commit messages with the current issue number. git/hooks directory and the file is executable it will run at the relevant point in the Git processes.
If Git finds a file named after one of its hooks in the. sample, you can remove this for them to start working or create a new file with just the hook name. These sample scripts won’t currently do anything as they are suffixed with. If you take a look at a Git repository you’ve cloned or initiated you should find a few sample scripts in the.
They provide a means of interacting with the default Git behaviour at various stages and add in custom functionality. Git hooks are scripts that reside within a repository’s. Thankfully this is straightforward to do by implementing one of the numerous Git hooks that exist. It’s a new process to me from the way I normally branch and commit I wanted to configure Git so that whenever I make a commit the branch name is checked and the issue number automatically prefixed to the commit message. Recently I’ve been working with a Git workflow that requires a specific format for branch names and commit messages: branch names are formatted to contain an issue number and each commit message is prefixed with the issue number it relates to.
0 kommentar(er)
