Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/endbug/add-and-commit

:octocat: Automatically commit changes made in your workflow run directly to your repo
https://github.com/endbug/add-and-commit

actions automation ci collaborate commit git git-add git-commit git-rm github github-actions hacktoberfest lint workflow

Last synced: 23 days ago
JSON representation

:octocat: Automatically commit changes made in your workflow run directly to your repo

Awesome Lists containing this project

README 

        
# Add & Commit



[![All Contributors](https://img.shields.io/github/all-contributors/EndBug/add-and-commit)](#contributors-)



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](#inputs)

- [Outputs](#outputs)

- [FAQs](#faqs)

- [Examples](#examples)

- [Contributors](#contributors-)

- [Articles](#articles)



## Inputs



Add a step like this to your workflow:



```yaml

- uses: EndBug/add-and-commit@v9 # 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.

    # Default: '.'

    cwd: './path/to/the/repo'



    # Determines the way the action fills missing author name and email. Three options are available:

    # - github_actor -> UserName 

    # - user_info -> Your Display Name 

    # - github_actions -> github-actions 

    # Default: github_actor

    default_author: github_actor



    # 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



    # Arguments for the git pull command. By default, the action does not pull.

    # Default: ''

    pull: '--rebase --autostash ...'



    # 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



    # 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`](https://npm.im/string-argv), and then used with [`simple-git`](https://npm.im/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](https://docs.github.com/en/actions/managing-workflow-runs/enabling-debug-logging) for your workflow runs or by testing it directly with `string-argv` ([RunKit demo](https://npm.runkit.com/string-argv)): if each argument and option is parsed correctly you'll see an array where every string is an option or value.



### Adding files



The action adds files using a regular `git add` command, so you can put every kind of argument in the `add` option. For example, if you want to force-add a file: `./path/to/file.txt --force`.  

The script will not stop if one of the git commands doesn't match any file. E.g.: if your command shows a "fatal: pathspec 'yourFile' did not match any files" error the action will go on.  

You can also use JSON or YAML arrays (e.g. `'["first", "second"]'`, `"['first', 'second']"`) to make the action run multiple `git add` commands: the action will log how your input has been parsed. Please mind that your input still needs to be a string because of how GitHub Actions works with inputs: just write your array inside the string, the action will parse it later.



### Deleting files



The `remove` option can be used if a predetermined list of files needs to be removed. It runs the `git rm` command, so you can pass every kind of argument with it. As if with the [`add` input](#adding-files), you can also use JSON or YAML arrays to make the action run multiple `git rm` commands.

 

If you want deleted files to be auto-detected and committed, you can use the [`--no-ignore-removal`/`-A`](https://git-scm.com/docs/git-add#Documentation/git-add.txt--A) git arguments.



### Pushing



By default the action runs the following command: `git push origin ${new_branch input} --set-upstream`. You can use the `push` input to modify this behavior, here's what you can set it to:



- `true`: this is the default value, it will behave as usual.

- `false`: this prevents the action from pushing at all, no `git push` command is run.

- any other string:  

  The action will use your string as the arguments for the `git push` command. Please note that nothing is used other than your arguments, and the command will result in `git push ${push input}` (no remote, no branch, no `--set-upstream`, you have to include them yourself).



One way to use this is if you want to force push to a branch of your repo: you'll need to set the `push` input to, for example, `origin yourBranch --force`.



### Creating a new branch



If you want the action to commit in a new branch, you can use the `new_branch` input.



Please note that if the branch exists, the action will still try push to it, but it's possible that the push will be rejected by the remote as non-straightforward.



If that's the case, you need to make sure that the branch you want to commit to is already checked out before you run the action.  

If you're **really** sure that you want to commit to that branch, you can also force-push by setting the `push` input to something like `origin yourBranchName --set-upstream --force`.



If you want to commit files "across different branches", here are two ways to do it:



1. You can check them out in two different directories, generate your files, move them to your destination and then run `add-and-commit` in the destination directory using the `cwd` input.

2. You can manually commit those files with `git` commands as you would on your machine. There are several ways to do this depending on the scenario. One of them if to stash your changes, checkout the destination branch, and popping the stash. You can then use the `add-and-commit` action as usual. Please note that this is just an example and may not work for you, since your use case may be different.



### Tagging



You can use the `tag` option to enter the arguments for a `git tag` command. In order for the action to isolate the tag name from the rest of the arguments, it should be the first word not preceded by an hyphen (e.g. `-a tag-name -m "some other stuff"` is ok).  

You can also change the arguments of the push command for tags: every argument in the `tag_push` input will be appended to the `git push --tags` command.  

For more info on how git arguments are parsed, see [the "Git arguments" section](#git-arguments).



## Outputs



The action provides these outputs:



- `committed`: whether the action has created a commit (`'true'` or `'false'`)

- `commit_long_sha`: the full SHA of the commit that has just been created

- `commit_sha`: the short 7-character SHA of the commit that has just been created

- `pushed`: whether the action has pushed to the remote (`'true'` or `'false'`)

- `tagged`: whether the action has created a tag (`'true'` or `'false'`)

- `tag_pushed`: whether the action has pushed a tag (`'true'` or `'false'`)



For more info on how to use outputs, see ["Context and expression syntax"](https://docs.github.com/en/free-pro-team@latest/actions/reference/context-and-expression-syntax-for-github-actions).



## FAQs



### Working with PRs



By default, when you use `actions/checkout` on a PR, it will checkout the head commit in a detached head state.

If you want to make some changes, you have to checkout the branch the PR is coming from in the head repo.  

You can set it up like this:



```yaml

- uses: actions/checkout@v4

  with:

    repository: ${{ github.event.pull_request.head.repo.full_name }}

    ref: ${{ github.event.pull_request.head.ref }}

```



You can find the full docs for payloads of `pull_request` events [here](https://docs.github.com/en/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#webhook-payload-example-32).



If you're planning on running this only on "internal" PRs (where head and base are in the same repo) then you can omit the `repository` input.  

If you're planning to use this with PRs coming from other forks, please keep in mind that you might not have write access to those repos.

You can try setting up the repo with your PAT, as explained in the ["About tokens" paragraph](#about-tokens) of this section.



Keep in mind that this "custom checkout" is meant only for PRs: if your workflow runs on multiple events (like `push` or `workflow_dispatch`), you could try having this step run only for `pull_request` events, while other ones will trigger the usual checkout.  

If you wish to do so, you can use the `step.if` property, [here](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsif)'s the docs.



### About tokens



When pushing, the action uses the token that the local git repository has been configured with: that means that if you want to change it you'll need to do it in the steps that run before this action. For example: if you set up your repo with [`actions/checkout`](https://github.com/actions/checkout/) then you have to add the token there.  

Changing the token with which the repo is configured can be useful if you want to run CI checks on the commit pushed by this action; anyway, it has to be set up outside of this action.



The action automatically gets the GitHub token from a `github_token` input: this input should not be modified by the user, since it doesn't affect the commits as it's only used to access the GitHub API to get user info, in case they selected that option for the commit author.



### The commit from the action is not triggering CI!



That's because you're checking out the repo using the built-in [`GITHUB_TOKEN` secret](https://docs.github.com/en/actions/security-guides/automatic-token-authentication): GitHub sees that the push event has been triggered by a commit generated by CI, and doesn't run any further checks to avoid unintentional check loops.



**If you're sure** that you want the commits generated during CI to trigger other workflow runs, you can checkout the repo using a [Personal Access Token (PAT)](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token): this will make the resulting commit the same as if you made it yourself.  

If you're using `actions/checkout`, check out their [docs](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) to see how to set your repo token.



### About `actions/checkout`



The token you use when setting up the repo with this action will determine what token `add-and-commit` will use.  

Some users reported that they were getting an error:



```

> fatal: could not read Username for 'https://github.com': No such device or address

```



If you're getting this error and you're using `actions/checkout@v1`, try upgrading to `actions/checkout@v2`. If you're still having problems after upgrading, feel free to open an issue. Issue ref: [#146](https://github.com/EndBug/add-and-commit/issues/146)



### Performance on large repos



By default, the action will fetch the repository before starting to work on it: this ensures that it can see the already existing refs.  



When working with a repository that has a lot of branches and tags, fetching it can take a long time. If the fetch step is taking too much time, you can decide to skip it by setting the `fetch` input to `false`: this will prevent the action from running `git fetch` altogether. 



Please note that you have to set up your workflow accordingly: not fetching the repo can impact branch and tag creation within the action, and for this reason it's recommended to disable it only if necessary. Issue ref: [#386](https://github.com/EndBug/add-and-commit/issues/386)



## Examples



### Different author/committer configurations



If you don't want to use your GitHub username for the CI commits, you can use the `default_author` input to make it appear as if it was made by "GitHub Actions", by setting its value to `github_actions`.






```yaml

on: push

jobs:

  build:

    runs-on: ubuntu-latest

    steps:

      - uses: EndBug/add-and-commit@v9

        with:

          default_author: github_actions

```



You can also use the `committer_name` and `committer_email` inputs to make it appear as if GitHub Actions is the committer, here are a couple of example steps:






```yaml

- uses: EndBug/add-and-commit@v9

  with:

    message: Show GitHub Actions logo

    committer_name: GitHub Actions

    committer_email: [email protected]

```






```yaml

- uses: EndBug/add-and-commit@v9

  with:

    message: Show GitHub logo

    committer_name: GitHub Actions

    committer_email: 41898282+github-actions[bot]@users.noreply.github.com

```



### Array inputs



Due to limitations in the GitHub action APIs, all inputs must be either strings or booleans.

The action supports arrays in `add` and `remove`, but they have to be encoded as a string with a YAML flow sequence:



```yaml

- uses: EndBug/add-and-commit@v9

  with:

    add: '["afile.txt", "anotherfile.txt"]'

```



(note the single-quotes) or a YAML block sequence:



```yaml

- uses: EndBug/add-and-commit@v9

  with:

    add: |

      - afile.txt

      - anotherfile.txt

```



(Note the pipe character making it a multiline string.)



### Automated linting



Do you want to lint your JavaScript files, located in the `src` folder, with ESLint, so that fixable changes are done without your intervention? You can use a workflow like this:



```yaml

name: Lint source code

on: push



jobs:

  run:

    name: Lint with ESLint

    runs-on: ubuntu-latest

    steps:

      - name: Checkout repo

        uses: actions/checkout@v4



      - name: Set up Node.js

        uses: actions/setup-node@v4



      - name: Install dependencies

        run: npm install



      - name: Update source code

        run: eslint "src/**" --fix



      - name: Commit changes

        uses: EndBug/add-and-commit@v9

        with:

          author_name: Your Name

          author_email: [email protected]

          message: 'Your commit message'

          add: '*.js'

```



### Running the action in a different directory



If you need to run the action on a repository that is not located in [`$GITHUB_WORKSPACE`](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/using-environment-variables#default-environment-variables), you can use the `cwd` option: the action uses a `cd` normal command, so the path should follow bash standards.



```yaml

name: Use a different repository directory

on: push



jobs:

  run:

    name: Add a text file

    runs-on: ubuntu-latest



    steps:

      # If you need to, you can check out your repo to a different location

      - uses: actions/checkout@v4

        with:

          path: './pathToRepo/'



      # You can make whatever type of change to the repo...

      - run: echo "123" > ./pathToRepo/file.txt



      # ...and then use the action as you would normally do, but providing the path to the repo

      - uses: EndBug/add-and-commit@v9

        with:

          message: 'Add the very useful text file'

          add: '*.txt --force'

          cwd: './pathToRepo/'

```



## Articles



- [Console by CodeSee #156](https://console.substack.com/p/console-156)

- [MichealHeap.com](https://michaelheap.com/add-and-commit-action/)



## Contributors ✨



Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):



  

    

      Federico Grandi
Federico Grandi
πŸ’» πŸ“–

      Tor Egil Jacobsen
Tor Egil Jacobsen
πŸ’»

      Ivan Yelizariev
Ivan Yelizariev
πŸ€”

      jhhughes
jhhughes
πŸ›

      Π”ΠΌΠΈΡ‚Ρ€ΠΈΠΉ ОкСаний
Π”ΠΌΠΈΡ‚Ρ€ΠΈΠΉ ОкСаний
πŸ€”

      Brahma Dev
Brahma Dev
πŸ›

      Felix Rojo Lapalma
Felix Rojo Lapalma
πŸ›

    

    

      Robin Wijnant
Robin Wijnant
πŸ› πŸ’»

      Onilton Maciel
Onilton Maciel
πŸ€”

      Josh Soref
Josh Soref
πŸ“–

      ToMe25
ToMe25
πŸ’» πŸ€”

      JonasJacobsUserspace
JonasJacobsUserspace
πŸ›

      pvogt09
pvogt09
πŸ’»

      Connor Clark
Connor Clark
πŸ€”

    

    

      Benedek Kozma
Benedek Kozma
πŸ€” πŸ’»

      Dustin Brown
Dustin Brown
πŸ›

      Chris McIntosh
Chris McIntosh
πŸ›

      Kevin Saliou
Kevin Saliou
πŸ€”

      Joachim Jablon
Joachim Jablon
πŸ€”

      Tim Schwenke
Tim Schwenke
πŸ€”

      Possible Triangle
Possible Triangle
πŸ€”

    

    

      Dominik Schilling
Dominik Schilling
πŸ€” πŸ“– πŸ’»

      rugk
rugk
πŸ“–

      Caleb Cushing
Caleb Cushing
πŸ›

      Eero Ruohola
Eero Ruohola
πŸ› πŸ€”

      Vincent Chu
Vincent Chu
πŸ›

      Matt H
Matt H
πŸ“– πŸ€”

      danielwerg
danielwerg
πŸ“–

    

    

      Oliver Kopp
Oliver Kopp
πŸ€”

      Glenn Ko
Glenn Ko
πŸ€”

      Drew Wells
Drew Wells
πŸ€”

      Javier Segovia CΓ³rdoba
Javier Segovia CΓ³rdoba
πŸ€”

      Darylgolden
Darylgolden
πŸ›

      mcargille
mcargille
πŸ› πŸ’»

      secondman
secondman
πŸ“–

    

    

      Chris Mc
Chris Mc
πŸ“–

      Namya LG
Namya LG
πŸ“–

      Janne Julkunen
Janne Julkunen
πŸ€”

      Joshua Chen
Joshua Chen
πŸ›

      Akimo
Akimo
πŸ“–

      Julien Bouquillon
Julien Bouquillon
πŸ“–

      Aviv Peled
Aviv Peled
πŸ›

    

    

      Devin Buhl
Devin Buhl
πŸ›

      Erek Speed
Erek Speed
πŸ›

      Alexander Kachkaev
Alexander Kachkaev
πŸ›

      Manuel Rauber
Manuel Rauber
πŸ’»

      Gabor Greif
Gabor Greif
🚧 πŸ“–

      Keith Fung
Keith Fung
πŸ“–

      Jonah Lawrence
Jonah Lawrence
πŸ› πŸ’»

    

    

      Azeem Bande-Ali
Azeem Bande-Ali
πŸ“–

      Viacheslav Kudinov
Viacheslav Kudinov
πŸ›‘οΈ

      justanotheranonymoususer
justanotheranonymoususer
πŸ›

      Christophe Dervieux
Christophe Dervieux
πŸ“–

      Andreas Deininger
Andreas Deininger
πŸ“–

      Michael Droettboom
Michael Droettboom
🚧

      tommie
tommie
πŸ“–

    

  



This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!



### Additional credits



This action is inspired by [`git-auto-commit-action`](https://github.com/stefanzweifel/git-auto-commit-action) by [Stefan Zweifel](https://github.com/stefanzweifel).



## License



This action is distributed under the MIT license, check the [license](LICENSE) for more info.