Compare commits

..

139 Commits
v1.0.0 ... v3

Author SHA1 Message Date
Stefan Zweifel
8563bc2c47 Tag v3.0.0 2020-02-06 21:15:35 +01:00
Stefan Zweifel
657dcb0873 Merge pull request #40 from stefanzweifel/v3
Release: v3.0.0
2020-02-06 21:14:31 +01:00
Stefan Zweifel
1d39bb676c Merge pull request #41 from stefanzweifel/feature/make-branch-optional
Make branch option optional
2020-02-06 20:51:13 +01:00
Stefan Zweifel
864c975b87 Update README 2020-02-06 20:49:03 +01:00
Stefan Zweifel
33592697c4 Update Changelog 2020-02-06 20:43:04 +01:00
Stefan Zweifel
13e281008a Update entrypoint.sh 2020-02-06 17:51:55 +01:00
Stefan Zweifel
42e5be9ebb WIP 2020-02-05 21:39:14 +01:00
Stefan Zweifel
f0354eba45 WIP 2020-02-05 21:36:48 +01:00
Stefan Zweifel
af7b14b2cf WIP 2020-02-05 21:32:57 +01:00
Stefan Zweifel
5a4e81ccd7 WIP 2020-02-05 21:31:46 +01:00
Stefan Zweifel
0884c39e7e WIP 2020-02-05 21:28:18 +01:00
Stefan Zweifel
5ab45a4eef WIP 2020-02-05 21:26:30 +01:00
Stefan Zweifel
e20b39e8ed Remove branch default value 2020-02-05 21:24:36 +01:00
Stefan Zweifel
5df30c89b8 Update how commit is pushed 2020-02-05 21:22:54 +01:00
Stefan Zweifel
b197c5ff8c Set default value for branch 2020-02-05 21:12:20 +01:00
Stefan Zweifel
098f1a8051 Merge pull request #39 from stefanzweifel/feature/commiter-options
Add Options to change Commit User Name and Email and Author
2020-02-05 20:38:20 +01:00
Stefan Zweifel
a06032e34f Update Changelog 2020-02-05 20:36:12 +01:00
Stefan Zweifel
3185f2bd2a Update README 2020-02-05 20:27:14 +01:00
Stefan Zweifel
5432544bdb Update Docs 2020-02-05 20:24:25 +01:00
Stefan Zweifel
0a5fd7e510 Merge branch 'v3' into feature/commiter-options
# Conflicts:
#	README.md
#	entrypoint.sh
2020-02-05 20:12:29 +01:00
Stefan Zweifel
81fa501ea5 Merge pull request #36 from stefanzweifel/refactor/remove-git-setup
Remove need for GITHUB_TOKEN
2020-02-05 19:52:36 +01:00
Stefan Zweifel
3c60dc19b2 Update README 2020-02-04 21:27:15 +01:00
Stefan Zweifel
0822a9b930 Add commit_author input option 2020-02-04 21:02:40 +01:00
Stefan Zweifel
d47024e59c Add commit_user_name and commit_user_email inputs 2020-02-04 20:14:27 +01:00
Stefan Zweifel
ae384f95d0 Update Changelog 2020-02-04 19:43:08 +01:00
Stefan Zweifel
959e7d4eab Update README 2020-02-04 19:42:37 +01:00
Stefan Zweifel
b21b1abc6d Update Comment 2020-02-04 19:37:58 +01:00
Stefan Zweifel
35440b9386 Update README 2020-02-04 19:37:00 +01:00
Stefan Zweifel
99f6ce74b4 Update README.md 2020-01-14 14:44:34 +01:00
Stefan Zweifel
4ab94c0ec4 Remove creation of .netrc file 2020-01-13 21:23:03 +01:00
Stefan Zweifel
1a9ba81dae Merge pull request #32 from yelizariev/patch-2
delete args as not used
2020-01-11 21:40:52 +01:00
Stefan Zweifel
2043118160 Update Dockerfile 2020-01-11 21:35:29 +01:00
Stefan Zweifel
9879efa581 Merge pull request #34 from yelizariev/refactoring
refactoring: combine merge lib.sh to entrypoint.sh
2020-01-11 21:34:15 +01:00
Stefan Zweifel
3525430c70 Update README 2020-01-11 21:32:17 +01:00
Stefan Zweifel
db25cb8fde Add checkout@v2 example
Closes #33
2020-01-11 21:32:11 +01:00
Ivan Yelizariev
5dd90bb58c refactoring: combine merge lib.sh to entrypoint.sh
If we use "source /lib.sh", bash will point to wrong line in case of an error.
It's confusing on debuggin new features
2020-01-10 13:08:35 +05:00
Ivan Yelizariev
36610a4da0 delete args as not used
closes #31
2020-01-07 12:27:14 +05:00
Stefan Zweifel
26a56d2023 Add note to README about forks and PRs 2020-01-04 17:54:44 +01:00
Stefan Zweifel
6d7a33192e Release v2.5.0 2019-12-18 11:59:49 +01:00
Stefan Zweifel
d625ec8b28 Update Description of inputs 2019-12-18 11:58:17 +01:00
Stefan Zweifel
e870f94840 Update Changelog 2019-12-18 11:57:16 +01:00
Stefan Zweifel
4a6ffd0603 Merge pull request #24 from stefanzweifel/extract-logic-to-lib
Extract methods into lib.sh / Add shellcheck workflow
2019-12-16 14:57:24 +01:00
Stefan Zweifel
dcfe3115ff WIP 2019-12-12 21:40:03 +01:00
Stefan Zweifel
3f6e990b1e Update lib.sh 2019-12-12 21:14:38 +01:00
Stefan Zweifel
560cf49647 Update Workflow 2019-12-12 21:10:29 +01:00
Stefan Zweifel
c62363dd62 Add Workflow to run Shellcheck 2019-12-12 21:05:01 +01:00
Stefan Zweifel
7c85ce3dee Update path to lib.sh 2019-12-12 20:46:16 +01:00
Stefan Zweifel
8bb153baaa Update Dockerfile 2019-12-12 20:45:42 +01:00
Stefan Zweifel
68035425ff Update Path 2019-12-12 20:44:41 +01:00
Stefan Zweifel
3273c330f8 Fix path 2019-12-12 20:42:47 +01:00
Stefan Zweifel
4280601118 Create lib.sh and update entrypoint.sh 2019-12-12 20:41:00 +01:00
Stefan Zweifel
3c148f8a94 Merge pull request #22 from yelizariev/custom-repo-path
Add "repository" option for custom repository path
2019-12-10 20:20:25 +01:00
Ivan Yelizariev
d3ceacae7d Add "repository" option for custom repository path 2019-12-10 17:20:25 +05:00
Stefan Zweifel
d338d7dd00 Update README to latest version 2019-11-30 19:42:53 +01:00
Stefan Zweifel
f7e2c0f118 Release v2.4.0 2019-11-30 19:40:57 +01:00
Stefan Zweifel
8db04fa14f Merge pull request #21 from jkaan/feature/add-support-for-lfs
Install Git-LFS while building Dockerfile
2019-11-30 19:37:41 +01:00
Joey Kaan
44a415d3cb Install Git-LFS while building Dockerfile 2019-11-30 13:05:28 +01:00
Stefan Zweifel
af9e1689a5 Update Changelog 2019-11-27 20:07:24 +01:00
Stefan Zweifel
2b22ba6212 Merge pull request #19 from localheinz/fix/untracked
Fix: Use 'git status -s' to check for untracked/modified files
2019-11-27 20:03:09 +01:00
Andreas Möller
b1b8ae8b5c Fix: Use 'git status -s' to check for untracked/modified files 2019-11-27 11:24:27 +01:00
Stefan Zweifel
fb3de05451 Revert "Fix: Add files that are not tracked yet"
This reverts commit 65d8bdf167.
2019-11-24 12:21:42 +01:00
Stefan Zweifel
284d0b78f0 Fix: Add files that are not tracked yet (#17)
Fix: Add files that are not tracked yet
2019-11-22 13:00:18 +01:00
Stefan Zweifel
188fc2bd58 Delete foo 2019-11-22 12:59:27 +01:00
Andreas Möller
65d8bdf167 Fix: Add files that are not tracked yet 2019-11-22 11:55:58 +01:00
Stefan Zweifel
40255153c4 Fix Link in README 2019-11-04 20:09:04 +01:00
Stefan Zweifel
0ef5bf58dc Tag v2.3.0 2019-11-04 20:07:50 +01:00
Stefan Zweifel
e924b16154 Merge pull request #15 from gomorizsolt/issue-14_support-custom-git-params
Support custom git params.
Fixes #14
2019-11-04 20:04:09 +01:00
Gömöri Zsolt
2fb839c669 Remove is_defined() 2019-11-01 11:11:19 +01:00
Gömöri Zsolt
908446c002 Use :+ to avoid empty string 2019-11-01 11:03:23 +01:00
Gömöri Zsolt
2d23a29775 Use one-line if statement 2019-11-01 10:53:56 +01:00
Gömöri Zsolt
bdc88aff2c Re-add is_defined() to eliminate empty string in git commit 2019-11-01 10:44:09 +01:00
Gömöri Zsolt
ddcd35eaa8 Remove is_defined() approach 2019-11-01 10:19:20 +01:00
Gömöri Zsolt
760c9be2dc Define default value for file_pattern 2019-11-01 10:15:22 +01:00
Gömöri Zsolt
69d0349561 Log input params beforehand 2019-11-01 10:10:52 +01:00
Gömöri Zsolt
eecee2898e Follow GH Action's naming restrictions 2019-11-01 10:04:42 +01:00
Gömöri Zsolt
3889fd6a6c Add args entry to actions.yml 2019-11-01 09:51:54 +01:00
Gömöri Zsolt
1ad5315ba7 Fix log statement 2019-11-01 09:51:19 +01:00
gomorizsolt
fa043bd474 Remove junk code 2019-10-31 15:13:27 +01:00
gomorizsolt
af33cfbb5c Replace get_value with is_defined altogether 2019-10-31 14:49:38 +01:00
gomorizsolt
677efa2969 Remove blank line 2019-10-31 11:25:08 +01:00
gomorizsolt
b6dcf94303 Add is_defined and get_value to improve on code's reusability 2019-10-31 11:18:48 +01:00
gomorizsolt
a65a3a47cd Support commit options, update README.md accordingly 2019-10-31 09:02:56 +01:00
Stefan Zweifel
a607c57aa4 Update version in README 2019-10-26 16:38:54 +02:00
Stefan Zweifel
134234c02d Feature: Add File Pattern Input (#13)
Feature: Add File Pattern Input
2019-10-26 16:37:31 +02:00
Stefan Zweifel
73ba09a90c Update Description 2019-10-26 16:33:59 +02:00
Stefan Zweifel
92d05a9fc5 Update CHANGELOG 2019-10-26 16:33:17 +02:00
Stefan Zweifel
25c0d721b7 Reenable if condition 2019-10-26 14:00:59 +02:00
Stefan Zweifel
d6493da30b Disable if-condition 2019-10-26 13:58:34 +02:00
Stefan Zweifel
5de23163f2 Update actions.yml
Co-Authored-By: Zsolt Gomori <30864202+gomorizsolt@users.noreply.github.com>
2019-10-26 12:13:56 +02:00
Stefan Zweifel
16f4dc5956 Update README 2019-10-25 22:18:32 +02:00
Stefan Zweifel
03de600c97 Fixes 2019-10-25 20:57:03 +02:00
Stefan Zweifel
40956d2dbd Add file_pattern argument 2019-10-25 20:51:12 +02:00
Stefan Zweifel
9fc8aa621f Update issue templates 2019-10-03 20:24:57 +02:00
Stefan Zweifel
81c04ebd3c Create CODE_OF_CONDUCT.md 2019-10-03 20:19:57 +02:00
Stefan Zweifel
ef21fa22a3 Merge pull request #10 from mattdfloyd/patch-1
Update Dockerfile
2019-10-01 19:30:55 +02:00
mattdfloyd
e29ffba3a7 Update Dockerfile
Typo fix
2019-10-01 12:51:13 -04:00
Stefan Zweifel
c1a88fc967 Update README.md 2019-10-01 13:58:46 +02:00
Stefan Zweifel
12d8aff89d Update README 2019-09-22 15:05:43 +02:00
Stefan Zweifel
62474225c7 Update README 2019-09-22 14:52:33 +02:00
Stefan Zweifel
b60aaac666 Update README 2019-09-20 21:21:03 +02:00
Stefan Zweifel
3ffeab2fe0 Tag v2.1.0 2019-09-20 21:20:34 +02:00
Stefan Zweifel
5adbb8cb3e Use GITHUB_ACTOR instead of args 2019-09-20 20:34:57 +02:00
Stefan Zweifel
97f9868da0 Rename ref to branch 2019-09-20 20:26:41 +02:00
Stefan Zweifel
8a0c95d76c Merge pull request #7 from stefanzweifel/fix-branch-checkout
Bugfix: Fix git checkout and git push commands
2019-09-20 19:50:49 +02:00
Stefan Zweifel
4c6d2819f0 Update README 2019-09-20 10:47:19 +02:00
Stefan Zweifel
7fec5eda4a Cleanup 2019-09-20 10:46:35 +02:00
Stefan Zweifel
6c17ba31a9 Output $INPUT_REF 2019-09-20 10:43:15 +02:00
Stefan Zweifel
6f1c9227f5 Fix git push command 2019-09-20 10:37:16 +02:00
Stefan Zweifel
72e2d4cb1e Fix git checkout 2019-09-20 10:33:12 +02:00
Stefan Zweifel
8cc484cbc5 Add ref argument 2019-09-20 10:30:36 +02:00
Stefan Zweifel
ed0ebb9072 Log $PUSH_BRANCH value 2019-09-20 10:19:34 +02:00
Stefan Zweifel
0b91625aed WIP 2019-09-20 10:11:50 +02:00
Stefan Zweifel
ba1c2a6047 Try to fix that push command 2019-09-20 10:08:13 +02:00
Stefan Zweifel
12282205b7 Try to fix git push 2019-09-20 10:01:27 +02:00
Stefan Zweifel
ef8610f6df Fix git push 2019-09-20 09:56:20 +02:00
Stefan Zweifel
f4fd59c4d4 Use $PUSH_BRANCH in git push command 2019-09-20 09:49:26 +02:00
Stefan Zweifel
ea88bd7cde Try to fix checkout command 2019-09-20 09:42:26 +02:00
Stefan Zweifel
80f825a9bc Update how the branch is checked out 2019-09-20 09:27:50 +02:00
Stefan Zweifel
845dc426e7 Update README.md 2019-09-06 07:34:41 +02:00
Stefan Zweifel
fcfae8cf7e Merge pull request #5 from tupaschoal/patch-1
Fix puzzled explanation on README.md
2019-09-06 07:33:37 +02:00
Tulio Leao
ef125417f8 Fix puzzled explanation on README.md 2019-09-06 02:19:37 -03:00
Stefan Zweifel
709206b68e Update Changelog 2019-08-31 18:47:56 +02:00
Stefan Zweifel
c37291d29c Merge pull request #3 from stefanzweifel/dev
Make Action compatible with GitHub Actions BETA2 / YAML Version
2019-08-31 18:45:42 +02:00
Stefan Zweifel
fc34a4d3a2 Update README 2019-08-31 18:43:23 +02:00
Stefan Zweifel
e14499263c Add GH Actions Stuff to Dockerfile 2019-08-31 18:34:50 +02:00
Stefan Zweifel
11769ba87f Merge branch 'dev-tinker' into dev 2019-08-31 18:34:10 +02:00
Stefan Zweifel
0364ecfe57 Update Entrypoint 2019-08-31 18:34:01 +02:00
Stefan Zweifel
8d47eb33c5 Use Actions as Git User 2019-08-31 18:15:13 +02:00
Stefan Zweifel
49fa6b4e7a WIP 2019-08-31 18:14:28 +02:00
Stefan Zweifel
ef070dad05 Updates 2019-08-31 18:10:59 +02:00
Stefan Zweifel
fbe300afdf Tinker tinker 2019-08-31 18:07:25 +02:00
Stefan Zweifel
4b2201fcd1 Update Entrypoint 2019-08-31 18:02:55 +02:00
Stefan Zweifel
a93a9a308d Use git checkout 2019-08-27 20:30:31 +02:00
Stefan Zweifel
fdf062fc1c Switch to branch and setup remote origin 2019-08-27 20:26:44 +02:00
Stefan Zweifel
6280a31960 Remove entrypoint 2019-08-20 21:12:28 +02:00
Stefan Zweifel
1dd709d949 Update Dockerfile 2019-08-20 21:05:17 +02:00
Stefan Zweifel
8620a4b744 Update README 2019-08-20 21:05:10 +02:00
Stefan Zweifel
6057956931 Fix Typo 2019-08-20 20:51:00 +02:00
Stefan Zweifel
3fe53a7d31 Add actions.yml 2019-08-20 20:43:07 +02:00
9 changed files with 395 additions and 41 deletions

30
.github/ISSUE_TEMPLATE/bug_report.md vendored Normal file
View File

@@ -0,0 +1,30 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''
---
**Version of the Action**
`v2.x.x`
**Describe the bug**
A clear and concise description of what the bug is.
**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
**Expected behavior**
A clear and concise description of what you expected to happen.
**Screenshots**
If applicable, add screenshots to help explain your problem.
**Additional context**
Add any other context about the problem here.

View File

@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''
---
**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
**Describe the solution you'd like**
A clear and concise description of what you want to happen.
**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.
**Additional context**
Add any other context or screenshots about the feature request here.

12
.github/workflows/shellcheck.yml vendored Normal file
View File

@@ -0,0 +1,12 @@
name: Shellcheck
on: push
jobs:
shellcheck:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- name: shellcheck
uses: ludeeus/action-shellcheck@0.1.0

View File

@@ -4,7 +4,67 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
## [Unreleased](https://github.com/stefanzweifel/git-auto-commit-action/compare/v1.0.0...HEAD)
## [Unreleased](https://github.com/stefanzweifel/git-auto-commit-action/compare/v3.0.0...HEAD)
> TBD
## [v3.0.0](https://github.com/stefanzweifel/git-auto-commit-action/compare/v2.5.0...v3.0.0) - 2020-02-06
### Added
- Add `commit_user_name`, `commit_user_email` and `commit_author` input options for full customzation on how the commit is being created [#39](https://github.com/stefanzweifel/git-auto-commit-action/pull/39)
### Changed
- Make the `branch` input option optional [#41](https://github.com/stefanzweifel/git-auto-commit-action/pull/41)
### Removed
- Remove the need of a GITHUB_TOKEN. Users now have to use `actions/checkout@v2` or higher [#36](https://github.com/stefanzweifel/git-auto-commit-action/pull/36)
## [v2.5.0](https://github.com/stefanzweifel/git-auto-commit-action/compare/v2.4.0...v2.5.0) - 2019-12-18
### Added
- Add new `repository`-argument [#22](https://github.com/stefanzweifel/git-auto-commit-action/pull/22)
### Changed
- Extract logic of the Action into methods and into a separate file [#24](https://github.com/stefanzweifel/git-auto-commit-action/pull/24)
## [v2.4.0](https://github.com/stefanzweifel/git-auto-commit-action/compare/v2.3.0...v2.4.0) - 2019-11-30
### Added
- Commit untracked files [#19](https://github.com/stefanzweifel/git-auto-commit-action/pull/19) (fixes [#16](https://github.com/stefanzweifel/git-auto-commit-action/issues/16))
- Add support for Git-LFS [#21](https://github.com/stefanzweifel/git-auto-commit-action/pull/21) (fixes [#20](https://github.com/stefanzweifel/git-auto-commit-action/issues/20))
## [v2.3.0](https://github.com/stefanzweifel/git-auto-commit-action/compare/v2.2.0...v2.3.0) - 2019-11-04
### Added
- Add a new `commit_option`-argument. Allows users to define additional commit options for the `git-commit` command. [#14](https://github.com/stefanzweifel/git-auto-commit-action/pull/15)
## [v2.2.0](https://github.com/stefanzweifel/git-auto-commit-action/compare/v2.1.0...v2.2.0) - 2019-10-26
### Added
- Add new `file_pattern`-argument. Allows users to define which files should be added in the commit. [#13](https://github.com/stefanzweifel/git-auto-commit-action/pull/13)
## [v2.1.0](https://github.com/stefanzweifel/git-auto-commit-action/compare/v2.0.0...v2.1.0) - 2019-09-20
### Added
- Add `branch`-argument to determine, to which branch changes should be pushed. See README for usage details.
### Fixed
- Fixes Issue where changes couldn't be pushed to GitHub due to wrong ref-name.
### Removed
- Remove `commit_author_email` and `commit_author_name` arguments. The `$GITHUB_ACTOR` is now used as the Git Author
## [v2.0.0](https://github.com/stefanzweifel/git-auto-commit-action/compare/v1.0.0...v2.0.0) - 2019-08-31
### Changed
- Make Action Compatible with latest beta of GitHub Actions [#3](https://github.com/stefanzweifel/git-auto-commit-action/pull/3)
## v1.0.0 - 2019-06-10

76
CODE_OF_CONDUCT.md Normal file
View File

@@ -0,0 +1,76 @@
# Contributor Covenant Code of Conduct
## Our Pledge
In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.
## Our Standards
Examples of behavior that contributes to creating a positive environment
include:
* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
## Our Responsibilities
Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.
Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.
## Scope
This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at hello@stefanzweifel.io. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.
Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
[homepage]: https://www.contributor-covenant.org
For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq

View File

@@ -1,7 +1,7 @@
FROM alpine/git:1.0.7
LABEL "com.github.actions.name"="Auto Commit changed files"
LABEL "com.github.actions.description"="Auotmatically commit changed files and push changes back to remote repository."
LABEL "com.github.actions.description"="Automatically commits files which have been changed during the workflow run and push changes back to remote repository."
LABEL "com.github.actions.icon"="git-commit"
LABEL "com.github.actions.color"="orange"
@@ -9,6 +9,8 @@ LABEL "repository"="http://github.com/stefanzweifel/git-auto-commit-action"
LABEL "homepage"="http://github.com/stefanzweifel/git-auto-commit-action"
LABEL "maintainer"="Stefan Zweifel <hello@stefanzweifel.io>"
RUN apk add git-lfs
COPY entrypoint.sh /entrypoint.sh
ENTRYPOINT ["sh", "/entrypoint.sh"]

118
README.md
View File

@@ -1,56 +1,110 @@
# git-auto-commit-action
This GitHub Action automatically commits files which have been changed during a Workflow run and pushes the Commit back to GitHub.
The Committer is "GitHub Actions <actions@github.com>" and the Author of the Commit can be configured with environment variables.
This GitHub Action automatically commits files which have been changed during a Workflow run and pushes the commit back to GitHub.
The default committer is "GitHub Actions <actions@github.com>" and the default author of the commit is "Your GitHub Username <github_username@users.noreply.github.com>".
If no changes are available, the Actions does nothing.
If no changes are detected, the Action does nothing.
This Action has been inspired and adapted from the [auto-commit](https://github.com/cds-snc/github-actions/tree/master/auto-commit
)-Action of the Canadian Digital Service.
)-Action of the Canadian Digital Service and this [commit](https://github.com/elstudio/actions-js-build/blob/41d604d6e73d632e22eac40df8cc69b5added04b/commit/entrypoint.sh)-Action by Eric Johnson.
*This Action currently can't be used in conjunction with pull requests of forks. See [issue #25](https://github.com/stefanzweifel/git-auto-commit-action/issues/25) for more information.*
## Usage
You have to have an Action in your Workflow, which changes some of your project files.
**Note:** This Action requires that you use `action/checkout@v2` or above to checkout your repository.
Add the following step at the end of your job.
```yaml
- uses: stefanzweifel/git-auto-commit-action@v3.0.0
with:
commit_message: Apply automatic changes
# Optional name of the branch the commit should be pushed to
# Required if Action is used in Workflow listening to the `pull_request` event
branch: ${{ github.head_ref }}
# Optional git params
commit_options: '--no-verify --signoff'
# Optional glob pattern of files which should be added to the commit
file_pattern: src/\*.js
# Optional local file path to the repository
repository: .
# Optional commit user and author settings
commit_user_name: My GitHub Actions Bot
commit_user_email: my-github-actions-bot@example.org
commit_author: Author <actions@gitub.com>
```
The Action will only commit files back, if changes are available. The resulting commit **will not trigger** another GitHub Actions Workflow run!
It is recommended to use this Action in Workflows which listen to the `pull_request` event. If you want to use the Action on other events, you have to hardcode the value for `branch` as `github.head_ref` is only available in Pull Requests.
## Example Usage
This Action will only work, if the job in your Workflow changes project files.
The most common use case for this, is when you're running a Linter or Code-Style fixer on GitHub Actions.
In this example I'm running `php-cs-fixer` in a PHP project.
```terraform
workflow "php-cs-fixer" {
on = "push"
resolves = [
"auto-commit-php-cs-fixer"
]
}
```yaml
name: php-cs-fixer
action "php-cs-fixer" {
uses = "docker://oskarstark/php-cs-fixer-ga"
}
on: pull_request
action "auto-commit-php-cs-fixer" {
needs = ["php-cs-fixer"]
uses = "stefanzweifel/git-auto-commit-action@v1.0.0"
secrets = ["GITHUB_TOKEN"]
env = {
COMMIT_MESSAGE = "Apply php-cs-fixer changes"
COMMIT_AUTHOR_EMAIL = "john.doe@example.com"
COMMIT_AUTHOR_NAME = "John Doe"
}
}
jobs:
php-cs-fixer:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
with:
ref: ${{ github.head_ref }}
- name: Run php-cs-fixer
uses: docker://oskarstark/php-cs-fixer-ga
- uses: stefanzweifel/git-auto-commit-action@v3.0.0
with:
commit_message: Apply php-cs-fixer changes
branch: ${{ github.head_ref }}
```
## Secrets
```yaml
name: php-cs-fixer
The `GITHUB_TOKEN` secret is required. Add the secret in the Workflow Editor on github.com.
on: push
## Environment variables
jobs:
php-cs-fixer:
runs-on: ubuntu-latest
The following environment variables are required:
steps:
- uses: actions/checkout@v2
- `COMMIT_MESSAGE`: The commit message used when changes are available
- `COMMIT_AUTHOR_EMAIL`: The Commit Authors Email Address
- `COMMIT_AUTHOR_NAME`: The Commit Authors Name
- name: Run php-cs-fixer
uses: docker://oskarstark/php-cs-fixer-ga
- uses: stefanzweifel/git-auto-commit-action@v3.0.0
with:
commit_message: Apply php-cs-fixer changes
```
### Inputs
Checkout [`action.yml`](https://github.com/stefanzweifel/git-auto-commit-action/blob/master/action.yml) for a full list of supported inputs.
## Troubleshooting
- If your Workflow can't push the commit to the repository because of authentication issues, please update your Workflow configuration and usage of [`ations/checkout`](https://github.com/actions/checkout#usage). (Updating the `token` value with a Personal Access Token should fix your issues)
## Known Issues
- GitHub currently prohibits Actions like this to push changes from a fork to the upstream repository. See [issue #25](https://github.com/stefanzweifel/git-auto-commit-action/issues/25) for more information.
## Versioning

44
action.yml Normal file
View File

@@ -0,0 +1,44 @@
name: Git Auto Commit
description: 'Automatically commits files which have been changed during the workflow run and push changes back to remote repository.'
author: Stefan Zweifel <hello@stefanzweifel.io>
inputs:
commit_message:
description: Commit message
required: true
branch:
description: Git branch name, where changes should be pushed too. Required if Action is used on the `pull_request` event
required: false
default: ''
commit_options:
description: Commit options (eg. --no-verify)
required: false
file_pattern:
description: File pattern used for `git add`. For example `src/\*.js`
required: false
default: '.'
repository:
description: Local file path to the git repository. Defaults to the current directory (`.`)
required: false
default: '.'
commit_user_name:
description: Name used for the commit user
required: false
default: GitHub Actions
commit_user_email:
description: Email address used for the commit user
required: false
default: actions@github.com
commit_author:
description: Value used for the commit author. Defaults to the username of whoever triggered this workflow run.
required: false
default: ${{ github.actor }} <${{ github.actor }}@users.noreply.github.com>
runs:
using: 'docker'
image: 'Dockerfile'
branding:
icon: 'git-commit'
color: orange

View File

@@ -1,10 +1,66 @@
#!/bin/sh
#!/bin/bash
set -eu
git config --global user.email "actions@github.com"
git config --global user.name "GitHub Actions"
_main() {
_switch_to_repository
git add -A
git status
git commit -m "$COMMIT_MESSAGE" --author="$COMMIT_AUTHOR_NAME <$COMMIT_AUTHOR_EMAIL>" || echo "No changes found. Nothing to commit."
git push -u origin HEAD
if _git_is_dirty; then
_setup_git
_switch_to_branch
_add_files
_local_commit
_push_to_github
else
echo "Working tree clean. Nothing to commit."
fi
}
_switch_to_repository() {
echo "INPUT_REPOSITORY value: $INPUT_REPOSITORY";
cd $INPUT_REPOSITORY
}
_git_is_dirty() {
[[ -n "$(git status -s)" ]]
}
# Set up git user configuration
_setup_git ( ) {
git config --global user.name "$INPUT_COMMIT_USER_NAME"
git config --global user.email "$INPUT_COMMIT_USER_EMAIL"
}
_switch_to_branch() {
echo "INPUT_BRANCH value: $INPUT_BRANCH";
# Switch to branch from current Workflow run
git checkout $INPUT_BRANCH
}
_add_files() {
echo "INPUT_FILE_PATTERN: ${INPUT_FILE_PATTERN}"
git add "${INPUT_FILE_PATTERN}"
}
_local_commit() {
echo "INPUT_COMMIT_OPTIONS: ${INPUT_COMMIT_OPTIONS}"
git commit -m "$INPUT_COMMIT_MESSAGE" --author="$INPUT_COMMIT_AUTHOR" ${INPUT_COMMIT_OPTIONS:+"$INPUT_COMMIT_OPTIONS"}
}
_push_to_github() {
if [ -z "$INPUT_BRANCH" ]
then
git push origin
else
git push --set-upstream origin "HEAD:$INPUT_BRANCH"
fi
}
_main