add-and-commit

The add-and-commit action uses the token configured in the local git repository (typically set during the actions/checkout step).

Triggering CI on new commits

By default, if you use the built-in GITHUB_TOKEN secret, GitHub will not trigger subsequent workflow runs from the commits generated by this action to prevent infinite loops.

To ensure commits generated by this action do trigger CI, you must checkout the repository using a Personal Access Token (PAT) instead of the default GITHUB_TOKEN.

Arguments provided to inputs like add, commit, remove, pull, tag, and tag_push are not executed directly as CLI commands. Instead, they are parsed by the string-argv package and then passed to simple-git.

Warning: Strings with complex nested quotes may be parsed incorrectly. If you encounter issues, verify your argument string using string-argv or enable debug logging in your GitHub Action run.

Use this GitHub Action to commit changes made in your workflow run directly to your repository (e.g., for linting, documentation updates, or build artifacts).

To use it, add a step to your workflow file using the EndBug/add-and-commit@v10 action. You can specify various inputs to control how files are added, committed, and pushed.

- uses: EndBug/add-and-commit@v10
  with:
    add: 'src'
    message: 'Your commit message'

Pushing commits

The action defaults to running git push origin ${new_branch} --set-upstream. You can control this via the push input:

• true (default): Behaves normally.
• false: Prevents any git push command from running.
• any other string: The action executes git push ${push_input}. You must include the remote and branch manually (e.g., origin my-branch --force).

Tagging

Use the tag input to provide arguments for git tag. Crucial: The tag name must be the first word in the string that is not preceded by a hyphen (e.g., -a tag-name -m "message" is valid). You can append extra arguments to the tag push command using the tag_push input.

When using actions/checkout on a Pull Request, it defaults to a detached HEAD state. To make changes and commit them back to the source branch, you must explicitly checkout the head repository and ref.

If the PR is from an internal repository (same repo), you can omit the repository input. If the PR is from a fork, ensure you have write access or use a Personal Access Token (PAT) as described in the About tokens section.

- uses: actions/checkout@v4
  with:
    repository: ${{ github.event.pull_request.head.repo.full_name }}
    ref: ${{ github.event.pull_request.head.ref }}

Adding files

The add input accepts standard git add arguments. To add multiple specific paths or run multiple commands, you can provide a JSON or YAML array inside the string (e.g., '["file1", "file2"]').

Removing files

The remove input runs the git rm command. Like the add input, you can use JSON or YAML arrays to specify multiple files or commands. To auto-detect deleted files for committing, use the --no-ignore-removal or -A argument.

You can customize who appears as the author and committer of the changes.

• Use default_author: github_actions to make the author appear as "GitHub Actions".
• Use committer_name and committer_email to specify a custom committer identity.

Note: The github_token input is used internally to access the GitHub API for user info and should not be modified.

- uses: EndBug/add-and-commit@v10
  with:
    message: Show GitHub Actions logo
    committer_name: GitHub Actions
    committer_email: actions@github.com

If your repository is not located in the default $GITHUB_WORKSPACE (for example, if you used the path option in actions/checkout), use the cwd input to specify the target directory. The path should follow standard bash conventions.

- uses: EndBug/add-and-commit@v10
  with:
    message: 'Add the very useful text file'
    add: '*.txt --force'
    cwd: './pathToRepo/'

Due to GitHub Action API limitations, all inputs must be strings or booleans. To pass arrays to the add or remove inputs, you must encode them as a string using either a YAML flow sequence (with single quotes) or a YAML block sequence (using the pipe | character).

# Using YAML flow sequence
- uses: EndBug/add-and-commit@v10
  with:
    add: '["afile.txt", "anotherfile.txt"]'

# Using YAML block sequence
- uses: EndBug/add-and-commit@v10
  with:
    add: |
      - afile.txt
      - anotherfile.txt

By default, the action performs a git fetch to ensure it can see existing refs. In repositories with a very large number of branches or tags, this can be slow.

You can skip this step by setting the fetch input to false.

Warning: Disabling fetch may impact the action's ability to create new branches or tags. Only disable it if necessary.