Compare commits

...

57 Commits

Author SHA1 Message Date
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
8 changed files with 272 additions and 42 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.

View File

@@ -4,7 +4,30 @@ 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/v2.2.0...HEAD)
## [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"

View File

@@ -1,56 +1,77 @@
# 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.
The Committer is "GitHub Actions <actions@github.com>" and the Author of the Commit is "Your GitHub Username <github_username@users.noreply.github.com>.
If no changes are available, the Actions 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 the [commit](https://github.com/elstudio/actions-js-build/blob/41d604d6e73d632e22eac40df8cc69b5added04b/commit/entrypoint.sh)-Action by Eric Johnson.
## Usage
You have to have an Action in your Workflow, which changes some of your project files.
Add the following step at the end of your job.
```yaml
- uses: stefanzweifel/git-auto-commit-action@v2.2.0
with:
commit_message: Apply automatic changes
branch: ${{ github.head_ref }}
# Optional glob pattern of files which should be added to the commit
file_pattern: src/\*.js
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
You **do not** have to create a new secret called `GITHUB_TOKEN` in your repository. `GITHUB_TOKEN` is a special token GitHub creates automatically during an Action run. (See [the documentation](https://help.github.com/en/articles/virtual-environments-for-github-actions#creating-and-using-secrets-encrypted-variables) for details)
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"
]
}
action "php-cs-fixer" {
uses = "docker://oskarstark/php-cs-fixer-ga"
}
```yaml
name: php-cs-fixer
on:
pull_request:
paths:
- '**.php'
jobs:
php-cs-fixer:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
with:
fetch-depth: 1
- name: Run php-cs-fixer
uses: docker://oskarstark/php-cs-fixer-ga
- name: Commit changed files
uses: stefanzweifel/git-auto-commit-action@v2.2.0
with:
commit_message: Apply php-cs-fixer changes
branch: ${{ github.head_ref }}
file_pattern: src/\*.php
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
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"
}
}
```
## Secrets
The `GITHUB_TOKEN` secret is required. Add the secret in the Workflow Editor on github.com.
## Environment variables
The following environment variables are required:
- `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
### Inputs
Checkout [`actions.yml`](https://github.com/stefanzweifel/git-auto-commit-action/blob/master/actions.yml) for a full list of supported inputs.
## Versioning

24
actions.yml Normal file
View File

@@ -0,0 +1,24 @@
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: Branch where changes should be pushed too
required: true
file_pattern:
description: File pattern used for "git add"
required: false
default: '.'
runs:
using: 'docker'
image: 'Dockerfile'
branding:
icon: 'git-commit'
color: orange

View File

@@ -1,10 +1,46 @@
#!/bin/sh
set -eu
git config --global user.email "actions@github.com"
git config --global user.name "GitHub Actions"
# Set up .netrc file with GitHub credentials
git_setup ( ) {
cat <<- EOF > $HOME/.netrc
machine github.com
login $GITHUB_ACTOR
password $GITHUB_TOKEN
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
machine api.github.com
login $GITHUB_ACTOR
password $GITHUB_TOKEN
EOF
chmod 600 $HOME/.netrc
git config --global user.email "actions@github.com"
git config --global user.name "GitHub Actions"
}
# This section only runs if there have been file changes
echo "Checking for uncommitted changes in the git working tree."
if ! git diff --quiet
then
git_setup
echo "INPUT_BRANCH value: $INPUT_BRANCH";
# Switch to branch from current Workflow run
git checkout $INPUT_BRANCH
if [ -z ${INPUT_FILE_PATTERN+x} ];
then
git add .
else
echo "INPUT_FILE_PATTERN value: $INPUT_FILE_PATTERN";
git add $INPUT_FILE_PATTERN
fi
git commit -m "$INPUT_COMMIT_MESSAGE" --author="$GITHUB_ACTOR <$GITHUB_ACTOR@users.noreply.github.com>"
git push --set-upstream origin "HEAD:$INPUT_BRANCH"
else
echo "Working tree clean. Nothing to commit."
fi