GitHub Action to commit & push changes made in workflows :octocat:
Find a file
2022-01-06 02:32:39 +00:00
.github/workflows update scheduled jobs 2022-01-03 14:39:17 -03:00
reports Commit performed using Push and Commit action 2022-01-06 02:32:39 +00:00
action.yml Update action.yml 2021-12-21 09:58:49 -03:00
CONTRIBUTING.md first commit 2021-10-21 14:53:37 -03:00
LICENSE first commit 2021-10-21 14:53:37 -03:00
README.md Update README.md 2021-12-21 10:15:17 -03:00

Git Commit & Push action

Action test on Ubuntu Action test on MacOS Action test on Windows

GitHub Action to commit & push changes made in workflows :octocat:

Screenshot 2021-10-21 at 15 40 50

Note: This action is supported on all runners operating systems (ubuntu, macos, windows)


📚 Usage

Public workflows that use this action.

⚠️ Requirements

  • The actions/checkout is mandatory to use this action, as it will be necessary to access the repository files.

1⃣ Minimal: Commit and Push with default parameters

    steps:
      - uses: actions/checkout@v2.3.4
      # [...] --> steps with actions or commands updating repository files
      - uses: GuillaumeFalourd/git-commit-push@v1.1

2⃣ Full: Commit and Push with customized parameters

    steps:
      - uses: actions/checkout@v2.3.4
      # [...] --> steps with actions or commands updating repository files
      - uses: GuillaumeFalourd/git-commit-push@v1.1
        with:
          email: ${{ github.actor }}@users.noreply.github.com
          name: ${{ github.actor }}
          commit_message: your_message
          target_branch: target_branch_name
          files: file1 file2 directory1 directory2/file3
          remote_repository: https://github.com/owner/another_repository
          access_token: ${{ github.token }}
          force: true
          empty: true
          tags: true

▶️ Action Inputs

Field Mandatory Default Value Observation
email NO ${{ github.actor }}@users.noreply.github.com Github user email
e.g: octocat@github.com
name NO ${{ github.actor }} Github username
e.g: octocat
commit_message NO Commit performed using Push and Commit action Commit message
target_branch NO ${{ github.ref }} Branch to push the changes back
files NO . Files to add separated by space
e.g: file1 file2 directory1 directory2/file3
remote_repository NO origin Repository url to push the code
access_token NO ${{ github.token }} Personal Access Token is necessary if push to another repository
force NO 0 Whether to perform force push
empty NO 0 Whether to allow empty commit
tags NO 0 Whether to use --tags

🤝 Contributing

Guidelines

🏅 Licensed

☞ This repository uses the Apache License 2.0