Add & Commit

You can use this GitHub Action to commit changes made in your workflow run directly to your repo: for example, you use it to lint your code, update documentation, commit updated builds, etc...

Table of contents

• Inputs
• Outputs
• FAQs
• Examples
• Contributors
• Articles

Inputs

Add a step like this to your workflow:

- uses: EndBug/add-and-commit@v10 # You can change this to use a specific version.
  with:
    # The arguments for the `git add` command (see the paragraph below for more info)
    # Default: '.'
    add: 'src'

    # The name of the user that will be displayed as the author of the commit.
    # Default: depends on the default_author input
    author_name: Author Name

    # The email of the user that will be displayed as the author of the commit.
    # Default: depends on the default_author input
    author_email: [email protected]

    # Additional arguments for the git commit command. The --message argument is already set by the message input.
    # Default: ''
    commit: --signoff

    # The name of the custom committer you want to use, if different from the author of the commit.
    # Default: the name of the author (set with either author_name or default_author)
    committer_name: Committer Name

    # The email of the custom committer you want to use, if different from the author of the commit.
    # Default: the email of the author (set with either author_email or default_author)
    committer_email: [email protected]

    # The local path to the directory where your repository is located. You should use actions/checkout first to set it up.
    # Relative to the runner workspace, or an absolute path (e.g. ${{ github.workspace }}/path).
    # Note: $GITHUB_WORKSPACE is not expanded in with: — use ${{ github.workspace }} instead.
    # Default: '.'
    cwd: './path/to/the/repo'

    # Determines the way the action fills missing author name and email. Three options are available:
    # - github_actor -> UserName <[email protected]>
    # - user_info -> Your Display Name <[email protected]>
    # - github_actions -> github-actions <email associated with the github logo>
    # Default: github_actor
    default_author: github_actor

    # If true, validate inputs and report what would happen without mutating the repo
    # (no real add/rm/commit/tag/push/pull/fetch/checkout/config). Useful for tinkering.
    # Default: false
    dry_run: true

    # If true, allow custom git transports / scheme:: remote-helper URLs in argument inputs.
    # Keep false unless you need a custom remote helper and fully trust those inputs.
    # Default: false
    allow_unsafe_git_protocols: false

    # Arguments for the git fetch command. If set to false, the action won't fetch the repo.
    # For more info as to why fetching is usually recommended, please see the "Performance on large repos" FAQ. 
    # Default: --tags --force
    fetch: false

    # The message for the commit.
    # Default: 'Commit from GitHub Actions (name of the workflow)'
    message: 'Your commit message'

    # If this input is set, the action will push the commit to a new branch with this name.
    # Default: ''
    new_branch: custom-new-branch

    # The way the action should handle pathspec errors from the add and remove commands. Three options are available:
    # - ignore -> errors will be logged but the step won't fail
    # - exitImmediately -> the action will stop right away, and the step will fail
    # - exitAtEnd -> the action will go on, every pathspec error will be logged at the end, the step will fail.
    # Default: ignore
    pathspec_error_handling: ignore

    # Whether to pull from the remote. Set to true to run git pull with no extra
    # args, false (or omit) to skip, or a string for git pull arguments
    # (e.g. '--rebase --autostash').
    # Default: ''
    pull: true

    # Whether to push the commit and, if any, its tags to the repo. It can also be used to set the git push arguments (see the paragraph below for more info)
    # Default: true
    push: false

    # Max times to try pushing. If pull is set, the action re-pulls between failed attempts.
    # Default: 1
    push_attempts: 3

    # The arguments for the `git rm` command (see the paragraph below for more info)
    # Default: ''
    remove: './dir/old_file.js'

    # Arguments for the git tag command (the tag name always needs to be the first word not preceded by an hyphen)
    # Default: ''
    tag: 'v1.0.0 --force'

    # Arguments for the git push --tags command (any additional argument will be added after --tags)
    # Default: ''
    tag_push: '--force'

Git arguments

Multiple options let you provide the git arguments that you want the action to use. It's important to note that these arguments are not actually used with a CLI command, but they are parsed by a package called string-argv, and then used with simple-git.
What does this mean for you? It means that strings that contain a lot of nested quotes may be parsed incorrectly, and that specific ways of declaring arguments may not be supported by these libraries. If you're having issues with your argument strings you can check whether they're being parsed correctly either by enabling debug logging for your workflow runs or by testing it directly with string-argv (RunKit demo): if each argument and option is parsed correctly you'll see an array where every string is an option or value.

This is the beginning of the README. Read the rest at the original. Read the full README ↗