mirror of
https://github.com/stefanzweifel/git-auto-commit-action.git
synced 2025-08-02 00:16:10 +08:00
Compare commits
192 Commits
Author | SHA1 | Date | |
---|---|---|---|
|
dd055f6225 | ||
|
55734408b7 | ||
|
d317154f77 | ||
|
36489f4cb5 | ||
|
2530046e72 | ||
|
172c2a2fc3 | ||
|
480e111bf8 | ||
|
7659782c71 | ||
|
026f88c27c | ||
|
f73d11d461 | ||
|
2b6b90e8f1 | ||
|
e1770ec52b | ||
|
0453bb1c25 | ||
|
da55e4a0cf | ||
|
b1833bd054 | ||
|
6dfda22dd6 | ||
|
94c72aa7c5 | ||
|
87526a8aa1 | ||
|
844c808726 | ||
|
ce08dda6b3 | ||
|
0ad4c8ce73 | ||
|
3387b2f267 | ||
|
d4a53f1779 | ||
|
956a47433b | ||
|
f866b2a854 | ||
|
8744cc88ef | ||
|
57bbd38e56 | ||
|
eef5f33ea3 | ||
|
25e6f0b17d | ||
|
ae885f5d8c | ||
|
33e8fd937f | ||
|
404d2015f4 | ||
|
cd0530ad7a | ||
|
2a957f5c41 | ||
|
7e64e614a1 | ||
|
c887fa4a07 | ||
|
09d175379e | ||
|
cdb861eda0 | ||
|
6a853b60cc | ||
|
76f50fc3ad | ||
|
9b4acb8f10 | ||
|
d11ccd183d | ||
|
a156a1072e | ||
|
d69e5f0850 | ||
|
86f0c11c06 | ||
|
eda98fb9e5 | ||
|
844e852dde | ||
|
cca75e0840 | ||
|
ef107e1d4b | ||
|
e97d20ce65 | ||
|
3c9d7dd29d | ||
|
4ff392a586 | ||
|
69c53bd75e | ||
|
8563bc2c47 | ||
|
657dcb0873 | ||
|
1d39bb676c | ||
|
864c975b87 | ||
|
33592697c4 | ||
|
13e281008a | ||
|
42e5be9ebb | ||
|
f0354eba45 | ||
|
af7b14b2cf | ||
|
5a4e81ccd7 | ||
|
0884c39e7e | ||
|
5ab45a4eef | ||
|
e20b39e8ed | ||
|
5df30c89b8 | ||
|
b197c5ff8c | ||
|
098f1a8051 | ||
|
a06032e34f | ||
|
3185f2bd2a | ||
|
5432544bdb | ||
|
0a5fd7e510 | ||
|
81fa501ea5 | ||
|
3c60dc19b2 | ||
|
0822a9b930 | ||
|
d47024e59c | ||
|
ae384f95d0 | ||
|
959e7d4eab | ||
|
b21b1abc6d | ||
|
35440b9386 | ||
|
99f6ce74b4 | ||
|
4ab94c0ec4 | ||
|
1a9ba81dae | ||
|
2043118160 | ||
|
9879efa581 | ||
|
3525430c70 | ||
|
db25cb8fde | ||
|
5dd90bb58c | ||
|
36610a4da0 | ||
|
26a56d2023 | ||
|
6d7a33192e | ||
|
d625ec8b28 | ||
|
e870f94840 | ||
|
4a6ffd0603 | ||
|
dcfe3115ff | ||
|
3f6e990b1e | ||
|
560cf49647 | ||
|
c62363dd62 | ||
|
7c85ce3dee | ||
|
8bb153baaa | ||
|
68035425ff | ||
|
3273c330f8 | ||
|
4280601118 | ||
|
3c148f8a94 | ||
|
d3ceacae7d | ||
|
d338d7dd00 | ||
|
f7e2c0f118 | ||
|
8db04fa14f | ||
|
44a415d3cb | ||
|
af9e1689a5 | ||
|
2b22ba6212 | ||
|
b1b8ae8b5c | ||
|
fb3de05451 | ||
|
284d0b78f0 | ||
|
188fc2bd58 | ||
|
65d8bdf167 | ||
|
40255153c4 | ||
|
0ef5bf58dc | ||
|
e924b16154 | ||
|
2fb839c669 | ||
|
908446c002 | ||
|
2d23a29775 | ||
|
bdc88aff2c | ||
|
ddcd35eaa8 | ||
|
760c9be2dc | ||
|
69d0349561 | ||
|
eecee2898e | ||
|
3889fd6a6c | ||
|
1ad5315ba7 | ||
|
fa043bd474 | ||
|
af33cfbb5c | ||
|
677efa2969 | ||
|
b6dcf94303 | ||
|
a65a3a47cd | ||
|
a607c57aa4 | ||
|
134234c02d | ||
|
73ba09a90c | ||
|
92d05a9fc5 | ||
|
25c0d721b7 | ||
|
d6493da30b | ||
|
5de23163f2 | ||
|
16f4dc5956 | ||
|
03de600c97 | ||
|
40956d2dbd | ||
|
9fc8aa621f | ||
|
81c04ebd3c | ||
|
ef21fa22a3 | ||
|
e29ffba3a7 | ||
|
c1a88fc967 | ||
|
12d8aff89d | ||
|
62474225c7 | ||
|
b60aaac666 | ||
|
3ffeab2fe0 | ||
|
5adbb8cb3e | ||
|
97f9868da0 | ||
|
8a0c95d76c | ||
|
4c6d2819f0 | ||
|
7fec5eda4a | ||
|
6c17ba31a9 | ||
|
6f1c9227f5 | ||
|
72e2d4cb1e | ||
|
8cc484cbc5 | ||
|
ed0ebb9072 | ||
|
0b91625aed | ||
|
ba1c2a6047 | ||
|
12282205b7 | ||
|
ef8610f6df | ||
|
f4fd59c4d4 | ||
|
ea88bd7cde | ||
|
80f825a9bc | ||
|
845dc426e7 | ||
|
fcfae8cf7e | ||
|
ef125417f8 | ||
|
709206b68e | ||
|
c37291d29c | ||
|
fc34a4d3a2 | ||
|
e14499263c | ||
|
11769ba87f | ||
|
0364ecfe57 | ||
|
8d47eb33c5 | ||
|
49fa6b4e7a | ||
|
ef070dad05 | ||
|
fbe300afdf | ||
|
4b2201fcd1 | ||
|
a93a9a308d | ||
|
fdf062fc1c | ||
|
6280a31960 | ||
|
1dd709d949 | ||
|
8620a4b744 | ||
|
6057956931 | ||
|
3fe53a7d31 |
30
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
30
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal 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.
|
20
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
20
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal 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.
|
31
.github/workflows/continuous-deployment.yml
vendored
Normal file
31
.github/workflows/continuous-deployment.yml
vendored
Normal file
@@ -0,0 +1,31 @@
|
|||||||
|
# https://help.github.com/en/categories/automating-your-workflow-with-github-actions
|
||||||
|
|
||||||
|
name: "Continuous Deployment"
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
tags:
|
||||||
|
- "**"
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
release:
|
||||||
|
name: "Release"
|
||||||
|
|
||||||
|
runs-on: "ubuntu-latest"
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: "Determine tag"
|
||||||
|
id: "determine-tag"
|
||||||
|
run: "echo \"::set-output name=tag::${GITHUB_REF#refs/tags/}\""
|
||||||
|
|
||||||
|
- name: "Create release"
|
||||||
|
uses: "actions/create-release@v1.0.0"
|
||||||
|
env:
|
||||||
|
GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
|
||||||
|
with:
|
||||||
|
draft: false
|
||||||
|
prerelease: false
|
||||||
|
body: |
|
||||||
|
See [Changelog](https://github.com/stefanzweifel/git-auto-commit-action/blob/master/CHANGELOG.md) for details.
|
||||||
|
release_name: "${{ steps.determine-tag.outputs.tag }}"
|
||||||
|
tag_name: "${{ steps.determine-tag.outputs.tag }}"
|
22
.github/workflows/git-auto-commit.yml
vendored
Normal file
22
.github/workflows/git-auto-commit.yml
vendored
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
name: git-auto-commit
|
||||||
|
|
||||||
|
on: push
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
git-auto-commit:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v2
|
||||||
|
|
||||||
|
- name: Use git-auto-commit-action
|
||||||
|
id: "auto-commit-action"
|
||||||
|
uses: ./
|
||||||
|
|
||||||
|
- name: "no changes detected"
|
||||||
|
if: steps.auto-commit-action.outputs.changes_detected == false
|
||||||
|
run: "echo \"No changes detected\""
|
||||||
|
|
||||||
|
- name: "changes detected"
|
||||||
|
if: steps.auto-commit-action.outputs.changes_detected == true
|
||||||
|
run: "echo \"Changes detected\""
|
12
.github/workflows/shellcheck.yml
vendored
Normal file
12
.github/workflows/shellcheck.yml
vendored
Normal 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
|
83
CHANGELOG.md
83
CHANGELOG.md
@@ -4,7 +4,88 @@ 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/)
|
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).
|
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/v4.1.2...HEAD)
|
||||||
|
|
||||||
|
## [v4.1.2](https://github.com/stefanzweifel/git-auto-commit-action/compare/v4.1.1...v4.1.2) - 2020-04-03
|
||||||
|
|
||||||
|
### Fixes
|
||||||
|
- Fix Issue with `changes_detected`-output [#57](https://github.com/stefanzweifel/git-auto-commit-action/pull/57)
|
||||||
|
|
||||||
|
## [v4.1.1](https://github.com/stefanzweifel/git-auto-commit-action/compare/v4.1.0...v4.1.1) - 2020-03-14
|
||||||
|
|
||||||
|
### Fixes
|
||||||
|
- Fix issue where commit has not been pushed to remote repository, when no `branch`-option has been given [#54](https://github.com/stefanzweifel/git-auto-commit-action/pull/54)
|
||||||
|
|
||||||
|
|
||||||
|
## [v4.1.0](https://github.com/stefanzweifel/git-auto-commit-action/compare/v4.0.0...v4.1.0) - 2020-03-05
|
||||||
|
|
||||||
|
### Added
|
||||||
|
- Add `changes_detected` output [#49](https://github.com/stefanzweifel/git-auto-commit-action/pull/49), [#46](https://github.com/stefanzweifel/git-auto-commit-action/issues/46)
|
||||||
|
- Add `tagging_message` input option to create and push tags [#50](https://github.com/stefanzweifel/git-auto-commit-action/pull/50), [#47](https://github.com/stefanzweifel/git-auto-commit-action/issues/47)
|
||||||
|
|
||||||
|
|
||||||
|
## [v4.0.0](https://github.com/stefanzweifel/git-auto-commit-action/compare/v3.0.0...v4.0.0) - 2020-02-24
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
- Switch Action to use `node12`-environment instead of `docker`. [#45](https://github.com/stefanzweifel/git-auto-commit-action/pull/45)
|
||||||
|
|
||||||
|
## [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
|
## v1.0.0 - 2019-06-10
|
||||||
|
|
||||||
|
76
CODE_OF_CONDUCT.md
Normal file
76
CODE_OF_CONDUCT.md
Normal 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
|
14
Dockerfile
14
Dockerfile
@@ -1,14 +0,0 @@
|
|||||||
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.icon"="git-commit"
|
|
||||||
LABEL "com.github.actions.color"="orange"
|
|
||||||
|
|
||||||
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>"
|
|
||||||
|
|
||||||
COPY entrypoint.sh /entrypoint.sh
|
|
||||||
|
|
||||||
ENTRYPOINT ["sh", "/entrypoint.sh"]
|
|
166
README.md
166
README.md
@@ -1,56 +1,158 @@
|
|||||||
# git-auto-commit-action
|
# 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.
|
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.
|
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
|
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
|
## 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@v4.1.2
|
||||||
|
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@github.com>
|
||||||
|
|
||||||
|
# Optional tag message. Will create and push a new tag to the remote repository
|
||||||
|
tagging_message: 'v1.0.0'
|
||||||
|
```
|
||||||
|
|
||||||
|
The Action will only commit files back, if changes are available. The resulting commit **will not trigger** another GitHub Actions Workflow run!
|
||||||
|
|
||||||
|
We recommend to use this Action in Workflows, which listen to the `pull_request` event. You can then use the option `branch: ${{ github.head_ref }}` to set up the branch name correctly.
|
||||||
|
If you don't pass a branch name, the Action will try to push the commit to a branch with the same name, as with which the repo has been checked out.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
This Action will only work, if the job in your Workflow changes files.
|
||||||
The most common use case for this, is when you're running a Linter or Code-Style fixer on GitHub Actions.
|
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.
|
In this example I'm running `php-cs-fixer` in a PHP project.
|
||||||
|
|
||||||
```terraform
|
### Example on `pull_request` event
|
||||||
workflow "php-cs-fixer" {
|
|
||||||
on = "push"
|
|
||||||
resolves = [
|
|
||||||
"auto-commit-php-cs-fixer"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
|
|
||||||
action "php-cs-fixer" {
|
```yaml
|
||||||
uses = "docker://oskarstark/php-cs-fixer-ga"
|
name: php-cs-fixer
|
||||||
}
|
|
||||||
|
|
||||||
action "auto-commit-php-cs-fixer" {
|
on: pull_request
|
||||||
needs = ["php-cs-fixer"]
|
|
||||||
uses = "stefanzweifel/git-auto-commit-action@v1.0.0"
|
jobs:
|
||||||
secrets = ["GITHUB_TOKEN"]
|
php-cs-fixer:
|
||||||
env = {
|
runs-on: ubuntu-latest
|
||||||
COMMIT_MESSAGE = "Apply php-cs-fixer changes"
|
|
||||||
COMMIT_AUTHOR_EMAIL = "john.doe@example.com"
|
steps:
|
||||||
COMMIT_AUTHOR_NAME = "John Doe"
|
- 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@v4.1.2
|
||||||
|
with:
|
||||||
|
commit_message: Apply php-cs-fixer changes
|
||||||
|
branch: ${{ github.head_ref }}
|
||||||
```
|
```
|
||||||
|
|
||||||
## Secrets
|
### Example on `push` event
|
||||||
|
|
||||||
The `GITHUB_TOKEN` secret is required. Add the secret in the Workflow Editor on github.com.
|
```yaml
|
||||||
|
name: php-cs-fixer
|
||||||
|
|
||||||
## Environment variables
|
on: push
|
||||||
|
|
||||||
The following environment variables are required:
|
jobs:
|
||||||
|
php-cs-fixer:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
- `COMMIT_MESSAGE`: The commit message used when changes are available
|
steps:
|
||||||
- `COMMIT_AUTHOR_EMAIL`: The Commit Authors Email Address
|
- uses: actions/checkout@v2
|
||||||
- `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@v4.1.2
|
||||||
|
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.
|
||||||
|
|
||||||
|
## Outputs
|
||||||
|
You can use these outputs to trigger other Actions in your Workflow run based on the result of `git-auto-commit-action`.
|
||||||
|
|
||||||
|
- `changes_detected`: Returns either "true" or "false" if the repository was dirty and files have changed.
|
||||||
|
|
||||||
|
## Troubleshooting
|
||||||
|
|
||||||
|
### Can't push commit to repository
|
||||||
|
If your Workflow can't push the commit to the repository because of authentication issues, please update your Workflow configuration and usage of [`actions/checkout`](https://github.com/actions/checkout#usage). (Updating the `token` value with a Personal Access Token should fix your issues)
|
||||||
|
|
||||||
|
### Commit of this Action does not trigger a new Workflow run
|
||||||
|
As mentioned in the [Usage](#Usage) section, the commit created by this Action **will not trigger** a new Workflow run automatically.
|
||||||
|
|
||||||
|
This is due to limitations set up by GitHub:
|
||||||
|
|
||||||
|
> An action in a workflow run can't trigger a new workflow run. For example, if an action pushes code using the repository's GITHUB_TOKEN, a new workflow will not run even when the repository contains a workflow configured to run when push events occur.
|
||||||
|
[Source](https://help.github.com/en/actions/reference/events-that-trigger-workflows)
|
||||||
|
|
||||||
|
You can change this by creating a new [Personal Access Token (PAT)](https://github.com/settings/tokens/new), storing the token as a secret in your repository and then passing the new token to the [`actions/checkout`](https://github.com/actions/checkout#usage) Action.
|
||||||
|
|
||||||
|
#### Example Workflow
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
name: php-cs-fixer
|
||||||
|
|
||||||
|
on: push
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
php-cs-fixer:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v2
|
||||||
|
with:
|
||||||
|
token: ${{ secrets.PAT_TOKEN }}
|
||||||
|
|
||||||
|
- name: Run php-cs-fixer
|
||||||
|
uses: docker://oskarstark/php-cs-fixer-ga
|
||||||
|
|
||||||
|
- uses: stefanzweifel/git-auto-commit-action@v4.1.2
|
||||||
|
with:
|
||||||
|
commit_message: Apply php-cs-fixer changes
|
||||||
|
```
|
||||||
|
|
||||||
|
## 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
|
## Versioning
|
||||||
|
|
||||||
|
52
action.yml
Normal file
52
action.yml
Normal file
@@ -0,0 +1,52 @@
|
|||||||
|
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>
|
||||||
|
tagging_message:
|
||||||
|
description: Message used to create a new git tag with the commit. Keep this empty, if no tag should be created.
|
||||||
|
required: false
|
||||||
|
default: ''
|
||||||
|
|
||||||
|
outputs:
|
||||||
|
changes_detected:
|
||||||
|
description: Value is "true", if the repository was dirty and file changes have been detected. Value is "false", if no changes have been detected.
|
||||||
|
|
||||||
|
runs:
|
||||||
|
using: 'node12'
|
||||||
|
main: 'index.js'
|
||||||
|
|
||||||
|
branding:
|
||||||
|
icon: 'git-commit'
|
||||||
|
color: orange
|
@@ -1,10 +1,91 @@
|
|||||||
#!/bin/sh
|
#!/bin/bash
|
||||||
|
|
||||||
set -eu
|
set -eu
|
||||||
|
|
||||||
git config --global user.email "actions@github.com"
|
_main() {
|
||||||
git config --global user.name "GitHub Actions"
|
_switch_to_repository
|
||||||
|
|
||||||
git add -A
|
if _git_is_dirty; then
|
||||||
git status
|
|
||||||
git commit -m "$COMMIT_MESSAGE" --author="$COMMIT_AUTHOR_NAME <$COMMIT_AUTHOR_EMAIL>" || echo "No changes found. Nothing to commit."
|
echo "::set-output name=changes_detected::true"
|
||||||
git push -u origin HEAD
|
|
||||||
|
_setup_git
|
||||||
|
|
||||||
|
_switch_to_branch
|
||||||
|
|
||||||
|
_add_files
|
||||||
|
|
||||||
|
_local_commit
|
||||||
|
|
||||||
|
_tag_commit
|
||||||
|
|
||||||
|
_push_to_github
|
||||||
|
else
|
||||||
|
|
||||||
|
echo "::set-output name=changes_detected::false"
|
||||||
|
|
||||||
|
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"}
|
||||||
|
}
|
||||||
|
|
||||||
|
_tag_commit() {
|
||||||
|
echo "INPUT_TAGGING_MESSAGE: ${INPUT_TAGGING_MESSAGE}"
|
||||||
|
|
||||||
|
if [ -n "$INPUT_TAGGING_MESSAGE" ]
|
||||||
|
then
|
||||||
|
git tag -a "$INPUT_TAGGING_MESSAGE" -m "$INPUT_TAGGING_MESSAGE"
|
||||||
|
else
|
||||||
|
echo " No tagging message supplied. No tag will be added."
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
_push_to_github() {
|
||||||
|
if [ -z "$INPUT_BRANCH" ]
|
||||||
|
then
|
||||||
|
# Only add `--tags` option, if `$INPUT_TAGGING_MESSAGE` is set
|
||||||
|
if [ -n "$INPUT_TAGGING_MESSAGE" ]
|
||||||
|
then
|
||||||
|
git push origin --tags
|
||||||
|
else
|
||||||
|
git push origin
|
||||||
|
fi
|
||||||
|
|
||||||
|
else
|
||||||
|
git push --set-upstream origin "HEAD:$INPUT_BRANCH" --tags
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
_main
|
||||||
|
34
index.js
Normal file
34
index.js
Normal file
@@ -0,0 +1,34 @@
|
|||||||
|
/**
|
||||||
|
* Most of this code has been copied from the following GitHub Action
|
||||||
|
* to make it simpler or not necessary to install a lot of
|
||||||
|
* JavaScript packages to execute a shell script.
|
||||||
|
*
|
||||||
|
* https://github.com/ad-m/github-push-action/blob/fe38f0a751bf9149f0270cc1fe20bf9156854365/start.js
|
||||||
|
*/
|
||||||
|
|
||||||
|
const spawn = require('child_process').spawn;
|
||||||
|
const path = require("path");
|
||||||
|
|
||||||
|
const exec = (cmd, args=[]) => new Promise((resolve, reject) => {
|
||||||
|
console.log(`Started: ${cmd} ${args.join(" ")}`)
|
||||||
|
const app = spawn(cmd, args, { stdio: 'inherit' });
|
||||||
|
app.on('close', code => {
|
||||||
|
if(code !== 0){
|
||||||
|
err = new Error(`Invalid status code: ${code}`);
|
||||||
|
err.code = code;
|
||||||
|
return reject(err);
|
||||||
|
};
|
||||||
|
return resolve(code);
|
||||||
|
});
|
||||||
|
app.on('error', reject);
|
||||||
|
});
|
||||||
|
|
||||||
|
const main = async () => {
|
||||||
|
await exec('bash', [path.join(__dirname, './entrypoint.sh')]);
|
||||||
|
};
|
||||||
|
|
||||||
|
main().catch(err => {
|
||||||
|
console.error(err);
|
||||||
|
console.error(err.stack);
|
||||||
|
process.exit(err.code || -1);
|
||||||
|
})
|
Reference in New Issue
Block a user