mirror of
https://github.com/stefanzweifel/git-auto-commit-action.git
synced 2026-01-11 12:08:25 +00:00
Compare commits
78 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
acbe8b15bf | ||
|
|
d1854850ec | ||
|
|
d2e5cae4c6 | ||
|
|
858005f1b9 | ||
|
|
9a4902607d | ||
|
|
d330c718ba | ||
|
|
5fe35a088d | ||
|
|
2da8d963b4 | ||
|
|
01d77ca6cb | ||
|
|
6371fedd09 | ||
|
|
f9017b24ee | ||
|
|
66f124b8c2 | ||
|
|
778341af66 | ||
|
|
33b203d92a | ||
|
|
a82d80a75f | ||
|
|
3cc016cfc8 | ||
|
|
ddb7ae4159 | ||
|
|
b001e5f0ff | ||
|
|
6494dc61d3 | ||
|
|
76180511d9 | ||
|
|
ae114628ea | ||
|
|
3058f91afb | ||
|
|
8ddf02de71 | ||
|
|
e7955f713c | ||
|
|
739fd03b2d | ||
|
|
af302a9c63 | ||
|
|
b863ae1933 | ||
|
|
adb37b5a29 | ||
|
|
8480c68cbb | ||
|
|
4f8f3ad16e | ||
|
|
11a6e5f38f | ||
|
|
35d037abf5 | ||
|
|
bf425dc136 | ||
|
|
cfd6ac4a3b | ||
|
|
19379b46c9 | ||
|
|
12e100dacb | ||
|
|
2ac10431a8 | ||
|
|
4db797a961 | ||
|
|
e256565ae5 | ||
|
|
8a23be4b32 | ||
|
|
ed295bd35a | ||
|
|
bd434eed48 | ||
|
|
1666a49083 | ||
|
|
1d986f74dd | ||
|
|
ad56d4eb46 | ||
|
|
9fa4cb99cf | ||
|
|
cec27bde37 | ||
|
|
244febd79d | ||
|
|
c86fa26bed | ||
|
|
e35726034b | ||
|
|
e348103e90 | ||
|
|
032ffbefae | ||
|
|
0b492c0d95 | ||
|
|
050015d406 | ||
|
|
573710f3d0 | ||
|
|
e961da7576 | ||
|
|
ac8823709a | ||
|
|
be823a7e51 | ||
|
|
55a82ca24f | ||
|
|
18157e6f3b | ||
|
|
7d779d0067 | ||
|
|
efd424db0f | ||
|
|
5f3fa8aed3 | ||
|
|
ee5525316d | ||
|
|
4b8a201e31 | ||
|
|
896cc0d225 | ||
|
|
7f171889c8 | ||
|
|
76f415fb30 | ||
|
|
3e796a0146 | ||
|
|
e833d4f211 | ||
|
|
0aca01a1ef | ||
|
|
03fddc470c | ||
|
|
ef7ed32535 | ||
|
|
9062db8404 | ||
|
|
80052f0645 | ||
|
|
3b8231379d | ||
|
|
d9307b5e8c | ||
|
|
aa2cec9c08 |
13
.github/ISSUE_TEMPLATE/bug.yaml
vendored
13
.github/ISSUE_TEMPLATE/bug.yaml
vendored
@@ -5,7 +5,7 @@ body:
|
|||||||
- type: markdown
|
- type: markdown
|
||||||
attributes:
|
attributes:
|
||||||
value: |
|
value: |
|
||||||
Before opening a bug report, please search for the behaviour in the existing issues.
|
Before opening a bug report, please search for the behaviour in existing issues or discussions.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -33,7 +33,7 @@ body:
|
|||||||
id: bug-description
|
id: bug-description
|
||||||
attributes:
|
attributes:
|
||||||
label: Bug description
|
label: Bug description
|
||||||
description: What exactly happened?
|
description: What exactly happened? Please describe your problem in detail.
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
- type: textarea
|
- type: textarea
|
||||||
@@ -52,7 +52,7 @@ body:
|
|||||||
id: example-workflow
|
id: example-workflow
|
||||||
attributes:
|
attributes:
|
||||||
label: Example Workflow
|
label: Example Workflow
|
||||||
description: Please share your GitHub Actions workflow which causes the bug. We use this to reproduce the error. No need for backticks here.
|
description: Please share the YAML-code of your GitHub Actions workflow which causes the bug. We use this to reproduce the error. If the workflow is in a private repostory, please provide a minimal example. (No need for backticks here, the pasted code will be correctly formatted.)
|
||||||
render: yaml
|
render: yaml
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
@@ -60,5 +60,10 @@ body:
|
|||||||
id: logs
|
id: logs
|
||||||
attributes:
|
attributes:
|
||||||
label: Relevant log output
|
label: Relevant log output
|
||||||
description: If applicable, provide relevant log output. No need for backticks here.
|
description: If applicable, provide relevant log output. Please copy and paste the output here, and make sure to remove any sensitive information. (No need for backticks here, the pasted code will be correctly formatted.)
|
||||||
render: shell
|
render: shell
|
||||||
|
- type: input
|
||||||
|
id: repository-url
|
||||||
|
attributes:
|
||||||
|
label: Repository
|
||||||
|
description: If applicable, please provide the repository where the bug occurred.
|
||||||
|
|||||||
2
.github/ISSUE_TEMPLATE/config.yml
vendored
2
.github/ISSUE_TEMPLATE/config.yml
vendored
@@ -4,5 +4,5 @@ contact_links:
|
|||||||
url: https://github.com/stefanzweifel/git-auto-commit-action/discussions/new?category=help
|
url: https://github.com/stefanzweifel/git-auto-commit-action/discussions/new?category=help
|
||||||
about: If you can't get something to work the way you expect, open a question in our discussion forums.
|
about: If you can't get something to work the way you expect, open a question in our discussion forums.
|
||||||
- name: Feature Request
|
- name: Feature Request
|
||||||
url: https://github.com/tailwindlabs/tailwindcss/discussions/new?category=ideas
|
url: https://github.com/stefanzweifel/git-auto-commit-action/discussions/new?category=ideas
|
||||||
about: 'Suggest any ideas you have using our discussion forums.'
|
about: 'Suggest any ideas you have using our discussion forums.'
|
||||||
|
|||||||
2
.github/workflows/git-auto-commit.yml
vendored
2
.github/workflows/git-auto-commit.yml
vendored
@@ -17,6 +17,8 @@ jobs:
|
|||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
|
with:
|
||||||
|
ref: ${{ github.head_ref }}
|
||||||
|
|
||||||
- name: Use git-auto-commit-action
|
- name: Use git-auto-commit-action
|
||||||
id: "auto-commit-action"
|
id: "auto-commit-action"
|
||||||
|
|||||||
2
.github/workflows/linter.yml
vendored
2
.github/workflows/linter.yml
vendored
@@ -12,7 +12,7 @@ jobs:
|
|||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
- name: Lint Code Base
|
- name: Lint Code Base
|
||||||
uses: github/super-linter@v5
|
uses: github/super-linter@v7
|
||||||
env:
|
env:
|
||||||
VALIDATE_ALL_CODEBASE: false
|
VALIDATE_ALL_CODEBASE: false
|
||||||
VALIDATE_MARKDOWN: false
|
VALIDATE_MARKDOWN: false
|
||||||
|
|||||||
2
.github/workflows/update-changelog.yaml
vendored
2
.github/workflows/update-changelog.yaml
vendored
@@ -27,7 +27,7 @@ jobs:
|
|||||||
latest-version: ${{ github.event.release.name }}
|
latest-version: ${{ github.event.release.name }}
|
||||||
|
|
||||||
- name: Commit updated CHANGELOG
|
- name: Commit updated CHANGELOG
|
||||||
uses: stefanzweifel/git-auto-commit-action@v5
|
uses: stefanzweifel/git-auto-commit-action@v6
|
||||||
with:
|
with:
|
||||||
branch: master
|
branch: master
|
||||||
commit_message: Update CHANGELOG
|
commit_message: Update CHANGELOG
|
||||||
|
|||||||
67
CHANGELOG.md
67
CHANGELOG.md
@@ -5,10 +5,75 @@ 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/v5.0.0...HEAD)
|
## [Unreleased](https://github.com/stefanzweifel/git-auto-commit-action/compare/v6.0.1...HEAD)
|
||||||
|
|
||||||
> TBD
|
> TBD
|
||||||
|
|
||||||
|
## [v6.0.1](https://github.com/stefanzweifel/git-auto-commit-action/compare/v6.0.0...v6.0.1) - 2025-06-11
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
|
||||||
|
- Disable Check if Repo is in Detached State ([#379](https://github.com/stefanzweifel/git-auto-commit-action/pull/379)) [@stefanzweifel](https://github.com/@stefanzweifel)
|
||||||
|
|
||||||
|
## [v6.0.0](https://github.com/stefanzweifel/git-auto-commit-action/compare/v5.2.0...v6.0.0) - 2025-06-10
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- Throw error early if repository is in a detached state ([#357](https://github.com/stefanzweifel/git-auto-commit-action/pull/357))
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
|
||||||
|
- Fix PAT instructions with Dependabot ([#376](https://github.com/stefanzweifel/git-auto-commit-action/pull/376)) [@Dreamsorcerer](https://github.com/@Dreamsorcerer)
|
||||||
|
|
||||||
|
### Removed
|
||||||
|
|
||||||
|
- Remove support for `create_branch`, `skip_checkout`, `skip_Fetch` ([#314](https://github.com/stefanzweifel/git-auto-commit-action/pull/314))
|
||||||
|
|
||||||
|
## [v5.2.0](https://github.com/stefanzweifel/git-auto-commit-action/compare/v5.1.0...v5.2.0) - 2025-04-19
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- Add `create_git_tag_only` option to skip commiting and always create a git-tag. ([#364](https://github.com/stefanzweifel/git-auto-commit-action/pull/364)) [@zMynxx](https://github.com/@zMynxx)
|
||||||
|
- Add Test for `create_git_tag_only` feature ([#367](https://github.com/stefanzweifel/git-auto-commit-action/pull/367)) [@stefanzweifel](https://github.com/@stefanzweifel)
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
|
||||||
|
- docs: Update README.md per #354 ([#361](https://github.com/stefanzweifel/git-auto-commit-action/pull/361)) [@rasa](https://github.com/@rasa)
|
||||||
|
|
||||||
|
## [v5.1.0](https://github.com/stefanzweifel/git-auto-commit-action/compare/v5.0.1...v5.1.0) - 2025-01-11
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
|
||||||
|
- Include `github.actor_id` in default `commit_author` ([#354](https://github.com/stefanzweifel/git-auto-commit-action/pull/354)) [@parkerbxyz](https://github.com/@parkerbxyz)
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
|
||||||
|
- docs(README): fix broken protected branch docs link ([#346](https://github.com/stefanzweifel/git-auto-commit-action/pull/346)) [@scarf005](https://github.com/@scarf005)
|
||||||
|
- Update README.md ([#343](https://github.com/stefanzweifel/git-auto-commit-action/pull/343)) [@Kludex](https://github.com/@Kludex)
|
||||||
|
|
||||||
|
### Dependency Updates
|
||||||
|
|
||||||
|
- Bump bats from 1.11.0 to 1.11.1 ([#353](https://github.com/stefanzweifel/git-auto-commit-action/pull/353)) [@dependabot](https://github.com/@dependabot)
|
||||||
|
- Bump github/super-linter from 6 to 7 ([#342](https://github.com/stefanzweifel/git-auto-commit-action/pull/342)) [@dependabot](https://github.com/@dependabot)
|
||||||
|
- Bump github/super-linter from 5 to 6 ([#335](https://github.com/stefanzweifel/git-auto-commit-action/pull/335)) [@dependabot](https://github.com/@dependabot)
|
||||||
|
|
||||||
|
## [v5.0.1](https://github.com/stefanzweifel/git-auto-commit-action/compare/v5.0.0...v5.0.1) - 2024-04-12
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
|
||||||
|
- Fail if attempting to execute git commands in a directory that is not a git-repo. ([#326](https://github.com/stefanzweifel/git-auto-commit-action/pull/326)) [@ccomendant](https://github.com/@ccomendant)
|
||||||
|
|
||||||
|
### Dependency Updates
|
||||||
|
|
||||||
|
- Bump bats from 1.10.0 to 1.11.0 ([#325](https://github.com/stefanzweifel/git-auto-commit-action/pull/325)) [@dependabot](https://github.com/@dependabot)
|
||||||
|
- Bump release-drafter/release-drafter from 5 to 6 ([#319](https://github.com/stefanzweifel/git-auto-commit-action/pull/319)) [@dependabot](https://github.com/@dependabot)
|
||||||
|
|
||||||
|
### Misc
|
||||||
|
|
||||||
|
- Clarify `commit_author` input option ([#315](https://github.com/stefanzweifel/git-auto-commit-action/pull/315)) [@npanuhin](https://github.com/@npanuhin)
|
||||||
|
- Add step id explanation for output in README.md ([#324](https://github.com/stefanzweifel/git-auto-commit-action/pull/324)) [@ChristianVermeulen](https://github.com/@ChristianVermeulen)
|
||||||
|
- Linux is not UNIX ([#321](https://github.com/stefanzweifel/git-auto-commit-action/pull/321)) [@couling](https://github.com/@couling)
|
||||||
|
|
||||||
## [v5.0.0](https://github.com/stefanzweifel/git-auto-commit-action/compare/v4.16.0...v5.0.0) - 2023-10-06
|
## [v5.0.0](https://github.com/stefanzweifel/git-auto-commit-action/compare/v4.16.0...v5.0.0) - 2023-10-06
|
||||||
|
|
||||||
New major release that bumps the default runtime to Node 20. There are no other breaking changes.
|
New major release that bumps the default runtime to Node 20. There are no other breaking changes.
|
||||||
|
|||||||
93
README.md
93
README.md
@@ -19,7 +19,7 @@ Adding git-auto-commit to your Workflow only takes a couple lines of code.
|
|||||||
2. Add the following step at the end of your job, after other steps that might add or change files.
|
2. Add the following step at the end of your job, after other steps that might add or change files.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- uses: stefanzweifel/git-auto-commit-action@v5
|
- uses: stefanzweifel/git-auto-commit-action@v6
|
||||||
```
|
```
|
||||||
|
|
||||||
Your Workflow should look similar to this example.
|
Your Workflow should look similar to this example.
|
||||||
@@ -40,11 +40,14 @@ jobs:
|
|||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
|
with:
|
||||||
|
ref: ${{ github.head_ref }}
|
||||||
|
|
||||||
# Other steps that change files in the repository
|
# Other steps that change files in the repository go here
|
||||||
|
# …
|
||||||
|
|
||||||
# Commit all changed files back to the repository
|
# Commit all changed files back to the repository
|
||||||
- uses: stefanzweifel/git-auto-commit-action@v5
|
- uses: stefanzweifel/git-auto-commit-action@v6
|
||||||
```
|
```
|
||||||
|
|
||||||
> [!NOTE]
|
> [!NOTE]
|
||||||
@@ -53,15 +56,14 @@ jobs:
|
|||||||
The following is an extended example with all available options.
|
The following is an extended example with all available options.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- uses: stefanzweifel/git-auto-commit-action@v5
|
- uses: stefanzweifel/git-auto-commit-action@v6
|
||||||
with:
|
with:
|
||||||
# Optional. Commit message for the created commit.
|
# Optional. Commit message for the created commit.
|
||||||
# Defaults to "Apply automatic changes"
|
# Defaults to "Apply automatic changes"
|
||||||
commit_message: Automated Change
|
commit_message: Automated Change
|
||||||
|
|
||||||
# Optional. Local and remote branch name where commit is going to be pushed
|
# Optional. Remote branch name where commit is going to be pushed to.
|
||||||
# to. Defaults to the current branch.
|
# Defaults to the current branch.
|
||||||
# You might need to set `create_branch: true` if the branch does not exist.
|
|
||||||
branch: feature-123
|
branch: feature-123
|
||||||
|
|
||||||
# Optional. Options used by `git-commit`.
|
# Optional. Options used by `git-commit`.
|
||||||
@@ -82,7 +84,7 @@ The following is an extended example with all available options.
|
|||||||
# Optional commit user and author settings
|
# Optional commit user and author settings
|
||||||
commit_user_name: My GitHub Actions Bot # defaults to "github-actions[bot]"
|
commit_user_name: My GitHub Actions Bot # defaults to "github-actions[bot]"
|
||||||
commit_user_email: my-github-actions-bot@example.org # defaults to "41898282+github-actions[bot]@users.noreply.github.com"
|
commit_user_email: my-github-actions-bot@example.org # defaults to "41898282+github-actions[bot]@users.noreply.github.com"
|
||||||
commit_author: Author <actions@github.com> # defaults to "username <username@users.noreply.github.com>", where "username" belongs to the author of the commit that triggered the run
|
commit_author: Author <actions@github.com> # defaults to "username <numeric_id+username@users.noreply.github.com>", where "numeric_id" and "username" belong to the author of the commit that triggered the run
|
||||||
|
|
||||||
# Optional. Tag name being created in the local repository and
|
# Optional. Tag name being created in the local repository and
|
||||||
# pushed to remote repository and defined branch.
|
# pushed to remote repository and defined branch.
|
||||||
@@ -115,6 +117,10 @@ The following is an extended example with all available options.
|
|||||||
|
|
||||||
# Optional. Create given branch name in local and remote repository.
|
# Optional. Create given branch name in local and remote repository.
|
||||||
create_branch: true
|
create_branch: true
|
||||||
|
|
||||||
|
# Optional. Creates a new tag and pushes it to remote without creating a commit.
|
||||||
|
# Skips dirty check and changed files. Must be used with `tagging_message`.
|
||||||
|
create_git_tag_only: false
|
||||||
```
|
```
|
||||||
|
|
||||||
Please note that the Action depends on `bash`. If you're using the Action in a job in combination with a custom Docker container, make sure that `bash` is installed.
|
Please note that the Action depends on `bash`. If you're using the Action in a job in combination with a custom Docker container, make sure that `bash` is installed.
|
||||||
@@ -151,7 +157,7 @@ jobs:
|
|||||||
- name: Run php-cs-fixer
|
- name: Run php-cs-fixer
|
||||||
uses: docker://oskarstark/php-cs-fixer-ga
|
uses: docker://oskarstark/php-cs-fixer-ga
|
||||||
|
|
||||||
- uses: stefanzweifel/git-auto-commit-action@v5
|
- uses: stefanzweifel/git-auto-commit-action@v6
|
||||||
with:
|
with:
|
||||||
commit_message: Apply php-cs-fixer changes
|
commit_message: Apply php-cs-fixer changes
|
||||||
```
|
```
|
||||||
@@ -166,13 +172,14 @@ You can use these outputs to trigger other Actions in your Workflow run based on
|
|||||||
|
|
||||||
- `changes_detected`: Returns either "true" or "false" if the repository was dirty and files have changed.
|
- `changes_detected`: Returns either "true" or "false" if the repository was dirty and files have changed.
|
||||||
- `commit_hash`: Returns the full hash of the commit if one was created.
|
- `commit_hash`: Returns the full hash of the commit if one was created.
|
||||||
|
- `create_git_tag_only`: Returns either "true" or "false" if a tag was created, when `create_git_tag_only` was used.
|
||||||
|
|
||||||
**⚠️ When using outputs, the step needs to be given an id. See example below.**
|
**⚠️ When using outputs, the step needs to be given an id. See example below.**
|
||||||
|
|
||||||
### Example
|
### Example
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- uses: stefanzweifel/git-auto-commit-action@v5
|
- uses: stefanzweifel/git-auto-commit-action@v6
|
||||||
id: auto-commit-action #mandatory for the output to show up in ${{ steps }}
|
id: auto-commit-action #mandatory for the output to show up in ${{ steps }}
|
||||||
with:
|
with:
|
||||||
commit_message: Apply php-cs-fixer changes
|
commit_message: Apply php-cs-fixer changes
|
||||||
@@ -231,10 +238,17 @@ storing the token as a secret in your repository and then passing the new token
|
|||||||
token: ${{ secrets.PAT }}
|
token: ${{ secrets.PAT }}
|
||||||
```
|
```
|
||||||
|
|
||||||
If you create a personal access token, apply the `repo` and `workflow` scopes.
|
If you create a personal access token (classic), apply the `repo` and `workflow` scopes.
|
||||||
|
If you create a fine-grained personal access token, apply the `Contents`-permissions.
|
||||||
|
|
||||||
If you work in an organization and don't want to create a PAT from your personal account, we recommend using a [robot account](https://docs.github.com/en/github/getting-started-with-github/types-of-github-accounts) for the token.
|
If you work in an organization and don't want to create a PAT from your personal account, we recommend using a [robot account](https://docs.github.com/en/github/getting-started-with-github/types-of-github-accounts) for the token.
|
||||||
|
|
||||||
|
### Prevent Infinite Loop when using a Personal Access Token
|
||||||
|
|
||||||
|
If you're using a Personal Access Token (PAT) to push commits to GitHub repository, the resulting commit or push can trigger other GitHub Actions workflows. This can result in an infinite loop.
|
||||||
|
|
||||||
|
If you would like to prevent this, you can add `skip-checks:true` to the commit message. See [Skipping workflow runs](https://docs.github.com/en/actions/managing-workflow-runs/skipping-workflow-runs) for details.
|
||||||
|
|
||||||
### Change to file is not detected
|
### Change to file is not detected
|
||||||
|
|
||||||
Does your workflow change a file, but "git-auto-commit" does not detect the change? Check the `.gitignore` that applies to the respective file. You might have accidentally marked the file to be ignored by git.
|
Does your workflow change a file, but "git-auto-commit" does not detect the change? Check the `.gitignore` that applies to the respective file. You might have accidentally marked the file to be ignored by git.
|
||||||
@@ -265,17 +279,38 @@ The example below can be used as a starting point to generate a multiline commit
|
|||||||
# Quick and dirty step to get rid of the temporary file holding the commit message
|
# Quick and dirty step to get rid of the temporary file holding the commit message
|
||||||
- run: rm -rf commitmessage.txt
|
- run: rm -rf commitmessage.txt
|
||||||
|
|
||||||
- uses: stefanzweifel/git-auto-commit-action@v5
|
- uses: stefanzweifel/git-auto-commit-action@v6
|
||||||
id: commit
|
id: commit
|
||||||
with:
|
with:
|
||||||
commit_message: ${{ steps.commit_message_step.outputs.commit_message }}
|
commit_message: ${{ steps.commit_message_step.outputs.commit_message }}
|
||||||
```
|
```
|
||||||
|
|
||||||
### Signing Commits & Other Git Command Line Options
|
### Signing Commits
|
||||||
|
|
||||||
Using command lines options needs to be done manually for each workflow which you require the option enabled. So for example signing commits requires you to import the gpg signature each and every time. The following list of actions are worth checking out if you need to automate these tasks regularly.
|
If you would like to sign your commits using a GPG key, you will need to use an additional action.
|
||||||
|
You can use the [crazy-max/ghaction-import-gpg](https://github.com/crazy-max/ghaction-import-gpg) action and follow its setup instructions.
|
||||||
|
|
||||||
- [Import GPG Signature](https://github.com/crazy-max/ghaction-import-gpg) (Suggested by [TGTGamer](https://github.com/tgtgamer))
|
As git-auto-commit by default does not use **your** username and email when creating a commit, you have to override these values in your workflow.
|
||||||
|
|
||||||
|
```yml
|
||||||
|
- name: "Import GPG key"
|
||||||
|
id: import-gpg
|
||||||
|
uses: crazy-max/ghaction-import-gpg@v6
|
||||||
|
with:
|
||||||
|
gpg_private_key: ${{ secrets.GPG_PRIVATE_KEY }}
|
||||||
|
passphrase: ${{ secrets.GPG_PASSPHRASE }}
|
||||||
|
git_user_signingkey: true
|
||||||
|
git_commit_gpgsign: true
|
||||||
|
|
||||||
|
- name: "Commit and push changes"
|
||||||
|
uses: stefanzweifel/git-auto-commit-action@v6
|
||||||
|
with:
|
||||||
|
commit_author: "${{ steps.import-gpg.outputs.name }} <${{ steps.import-gpg.outputs.email }}>"
|
||||||
|
commit_user_name: ${{ steps.import-gpg.outputs.name }}
|
||||||
|
commit_user_email: ${{ steps.import-gpg.outputs.email }}
|
||||||
|
```
|
||||||
|
|
||||||
|
See discussion [#334](https://github.com/stefanzweifel/git-auto-commit-action/discussions/334) for details.
|
||||||
|
|
||||||
### Use in forks from private repositories
|
### Use in forks from private repositories
|
||||||
|
|
||||||
@@ -345,7 +380,7 @@ jobs:
|
|||||||
- name: Run php-cs-fixer
|
- name: Run php-cs-fixer
|
||||||
uses: docker://oskarstark/php-cs-fixer-ga
|
uses: docker://oskarstark/php-cs-fixer-ga
|
||||||
|
|
||||||
- uses: stefanzweifel/git-auto-commit-action@v5
|
- uses: stefanzweifel/git-auto-commit-action@v6
|
||||||
```
|
```
|
||||||
|
|
||||||
For more information about running Actions on forks, see [this announcement from GitHub](https://github.blog/2020-08-03-github-actions-improvements-for-fork-and-pull-request-workflows/).
|
For more information about running Actions on forks, see [this announcement from GitHub](https://github.blog/2020-08-03-github-actions-improvements-for-fork-and-pull-request-workflows/).
|
||||||
@@ -380,7 +415,7 @@ The steps in your workflow might look like this:
|
|||||||
echo "message=$(git log -1 --pretty=%s)" >> $GITHUB_OUTPUT
|
echo "message=$(git log -1 --pretty=%s)" >> $GITHUB_OUTPUT
|
||||||
echo "author=$(git log -1 --pretty=\"%an <%ae>\")" >> $GITHUB_OUTPUT
|
echo "author=$(git log -1 --pretty=\"%an <%ae>\")" >> $GITHUB_OUTPUT
|
||||||
|
|
||||||
- uses: stefanzweifel/git-auto-commit-action@v5
|
- uses: stefanzweifel/git-auto-commit-action@v6
|
||||||
with:
|
with:
|
||||||
commit_author: ${{ steps.last-commit.outputs.author }}
|
commit_author: ${{ steps.last-commit.outputs.author }}
|
||||||
commit_message: ${{ steps.last-commit.outputs.message }}
|
commit_message: ${{ steps.last-commit.outputs.message }}
|
||||||
@@ -403,27 +438,41 @@ please update your Workflow configuration and usage of [`actions/checkout`](http
|
|||||||
|
|
||||||
Updating the `token` value with a Personal Access Token should fix your issues.
|
Updating the `token` value with a Personal Access Token should fix your issues.
|
||||||
|
|
||||||
|
### git-auto-commit fails to push commit that creates or updates files in `.github/workflows/`
|
||||||
|
|
||||||
|
The default `GITHUB_TOKEN` issued by GitHub Action does not have permission to make changes to workflow files located in `.github/workflows/`.
|
||||||
|
To fix this, please create a personal access token (PAT) and pass the token to the `actions/checkout`-step in your workflow. (Similar to [how to push to protected branches](https://github.com/stefanzweifel/git-auto-commit-action?tab=readme-ov-file#push-to-protected-branches)).
|
||||||
|
|
||||||
|
If a PAT does not work for you, you could also create a new GitHub app and use it's token in your workflows. See [this comment in #87](https://github.com/stefanzweifel/git-auto-commit-action/issues/87#issuecomment-1939138661) for details.
|
||||||
|
|
||||||
|
See [#322](https://github.com/stefanzweifel/git-auto-commit-action/issues/322) for details and discussions around this topic.
|
||||||
|
|
||||||
### Push to protected branches
|
### Push to protected branches
|
||||||
|
|
||||||
If your repository uses [protected branches](https://help.github.com/en/github/administering-a-repository/configuring-protected-branches) you have to make some changes to your Workflow for the Action to work properly: You need a Personal Access Token and you either have to allow force pushes or the Personal Access Token needs to belong to an Administrator.
|
If your repository uses [protected branches](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches) you have to make some changes to your Workflow for the Action to work properly: You need a Personal Access Token and you either have to allow force pushes or the Personal Access Token needs to belong to an Administrator.
|
||||||
|
|
||||||
First, you have to create a new [Personal Access Token (PAT)](https://github.com/settings/tokens/new),
|
First, you have to create a new [Personal Access Token (PAT)](https://github.com/settings/tokens/new),
|
||||||
store the token as a secret in your repository and pass the new token to the [`actions/checkout`](https://github.com/actions/checkout#usage) Action step.
|
store the token as a secret in your repository and pass the new token to the [`actions/checkout`](https://github.com/actions/checkout#usage) Action step.
|
||||||
|
|
||||||
|
If you create a personal access token (classic), apply the `repo` and `workflow` scopes.
|
||||||
|
If you create a fine-grained personal access token, apply the `Contents`-permissions.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
with:
|
with:
|
||||||
token: ${{ secrets.PAT }}
|
# We pass the "PAT" secret to the checkout action; if no PAT secret is available to the workflow runner (eg. Dependabot) we fall back to the default "GITHUB_TOKEN".
|
||||||
|
token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
|
||||||
```
|
```
|
||||||
You can learn more about Personal Access Token in the [GitHub documentation](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token).
|
You can learn more about Personal Access Token in the [GitHub documentation](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token).
|
||||||
|
|
||||||
|
|
||||||
> [!TIP]
|
> [!TIP]
|
||||||
> If you're working in an organisation, and you don't want to create the PAT from your personal account, we recommend using a bot-account for such tokens.
|
> If you're working in an organisation, and you don't want to create the PAT from your personal account, we recommend using a bot-account for such tokens.
|
||||||
|
|
||||||
If you go the "force pushes" route, you have to enable force pushes to a protected branch (see [documentation](https://help.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)) and update your Workflow to use force push like this.
|
If you go the "force pushes" route, you have to enable force pushes to a protected branch (see [documentation](https://help.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)) and update your Workflow to use force push like this.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- uses: stefanzweifel/git-auto-commit-action@v5
|
- uses: stefanzweifel/git-auto-commit-action@v6
|
||||||
with:
|
with:
|
||||||
commit_message: Apply php-cs-fixer changes
|
commit_message: Apply php-cs-fixer changes
|
||||||
push_options: --force
|
push_options: --force
|
||||||
@@ -453,7 +502,7 @@ This is due to the fact, that the `*.md`-glob is expanded before sending it to `
|
|||||||
To fix this add `disable_globbing: true` to your Workflow.
|
To fix this add `disable_globbing: true` to your Workflow.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- uses: stefanzweifel/git-auto-commit-action@v5
|
- uses: stefanzweifel/git-auto-commit-action@v6
|
||||||
with:
|
with:
|
||||||
file_pattern: '*.md'
|
file_pattern: '*.md'
|
||||||
disable_globbing: true
|
disable_globbing: true
|
||||||
@@ -481,7 +530,7 @@ yarn test
|
|||||||
|
|
||||||
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/stefanzweifel/git-auto-commit-action/tags).
|
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/stefanzweifel/git-auto-commit-action/tags).
|
||||||
|
|
||||||
We also provide major version tags to make it easier to always use the latest release of a major version. For example, you can use `stefanzweifel/git-auto-commit-action@v5` to always use the latest release of the current major version.
|
We also provide major version tags to make it easier to always use the latest release of a major version. For example, you can use `stefanzweifel/git-auto-commit-action@v6` to always use the latest release of the current major version.
|
||||||
(More information about this [here](https://help.github.com/en/actions/building-actions/about-actions#versioning-your-action).)
|
(More information about this [here](https://help.github.com/en/actions/building-actions/about-actions#versioning-your-action).)
|
||||||
|
|
||||||
## Credits
|
## Credits
|
||||||
|
|||||||
10
UPGRADING.md
Normal file
10
UPGRADING.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# Upgrading
|
||||||
|
|
||||||
|
## From v5 to v6
|
||||||
|
|
||||||
|
The following options have been removed from git-auto-commit and can be removed from your workflows.
|
||||||
|
|
||||||
|
- `create_branch` (git-auto-commit no longer switches branches locally during a workflow run)
|
||||||
|
- `skip_fetch`
|
||||||
|
- `skip_checkout`
|
||||||
|
|
||||||
11
action.yml
11
action.yml
@@ -43,7 +43,7 @@ inputs:
|
|||||||
commit_author:
|
commit_author:
|
||||||
description: Value used for the commit author. Defaults to the username of whoever triggered this workflow run.
|
description: Value used for the commit author. Defaults to the username of whoever triggered this workflow run.
|
||||||
required: false
|
required: false
|
||||||
default: ${{ github.actor }} <${{ github.actor }}@users.noreply.github.com>
|
default: ${{ github.actor }} <${{ github.actor_id }}+${{ github.actor }}@users.noreply.github.com>
|
||||||
tagging_message:
|
tagging_message:
|
||||||
description: Message used to create a new git tag with the commit. Keep this empty, if no tag should be created.
|
description: Message used to create a new git tag with the commit. Keep this empty, if no tag should be created.
|
||||||
required: false
|
required: false
|
||||||
@@ -70,18 +70,25 @@ inputs:
|
|||||||
create_branch:
|
create_branch:
|
||||||
description: Create new branch with the name of `branch`-input in local and remote repository, if it doesn't exist yet.
|
description: Create new branch with the name of `branch`-input in local and remote repository, if it doesn't exist yet.
|
||||||
default: false
|
default: false
|
||||||
|
create_git_tag_only:
|
||||||
|
description: Perform a clean git tag and push, without commiting anything
|
||||||
|
required: false
|
||||||
|
default: false
|
||||||
internal_git_binary:
|
internal_git_binary:
|
||||||
description: Internal use only! Path to git binary used to check if git is available. (Don't change this!)
|
description: Internal use only! Path to git binary used to check if git is available. (Don't change this!)
|
||||||
default: git
|
default: git
|
||||||
|
|
||||||
|
|
||||||
outputs:
|
outputs:
|
||||||
changes_detected:
|
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.
|
description: Value is "true", if the repository was dirty and file changes have been detected. Value is "false", if no changes have been detected.
|
||||||
commit_hash:
|
commit_hash:
|
||||||
description: Full hash of the created commit. Only present if the "changes_detected" output is "true".
|
description: Full hash of the created commit. Only present if the "changes_detected" output is "true".
|
||||||
|
create_git_tag_only:
|
||||||
|
description: Value is "true", if a git tag was created using the `create_git_tag_only`-input.
|
||||||
|
|
||||||
runs:
|
runs:
|
||||||
using: 'node20'
|
using: 'node24'
|
||||||
main: 'index.js'
|
main: 'index.js'
|
||||||
|
|
||||||
branding:
|
branding:
|
||||||
|
|||||||
@@ -31,7 +31,16 @@ _main() {
|
|||||||
|
|
||||||
_switch_to_repository
|
_switch_to_repository
|
||||||
|
|
||||||
if _git_is_dirty || "$INPUT_SKIP_DIRTY_CHECK"; then
|
_check_if_is_git_repository
|
||||||
|
|
||||||
|
_check_if_repository_is_in_detached_state
|
||||||
|
|
||||||
|
if "$INPUT_CREATE_GIT_TAG_ONLY"; then
|
||||||
|
_log "debug" "Create git tag only";
|
||||||
|
_set_github_output "create_git_tag_only" "true"
|
||||||
|
_tag_commit
|
||||||
|
_push_to_github
|
||||||
|
elif _git_is_dirty || "$INPUT_SKIP_DIRTY_CHECK"; then
|
||||||
|
|
||||||
_set_github_output "changes_detected" "true"
|
_set_github_output "changes_detected" "true"
|
||||||
|
|
||||||
@@ -86,11 +95,25 @@ _git_is_dirty() {
|
|||||||
gitStatusMessage="$((git status -s $INPUT_STATUS_OPTIONS -- ${INPUT_FILE_PATTERN_EXPANDED:+${INPUT_FILE_PATTERN_EXPANDED[@]}} >/dev/null ) 2>&1)";
|
gitStatusMessage="$((git status -s $INPUT_STATUS_OPTIONS -- ${INPUT_FILE_PATTERN_EXPANDED:+${INPUT_FILE_PATTERN_EXPANDED[@]}} >/dev/null ) 2>&1)";
|
||||||
# shellcheck disable=SC2086
|
# shellcheck disable=SC2086
|
||||||
gitStatus="$(git status -s $INPUT_STATUS_OPTIONS -- ${INPUT_FILE_PATTERN_EXPANDED:+${INPUT_FILE_PATTERN_EXPANDED[@]}})";
|
gitStatus="$(git status -s $INPUT_STATUS_OPTIONS -- ${INPUT_FILE_PATTERN_EXPANDED:+${INPUT_FILE_PATTERN_EXPANDED[@]}})";
|
||||||
if [ $? -ne 0 ]; then
|
[ -n "$gitStatus" ]
|
||||||
_log "error" "git-status failed with:<$gitStatusMessage>";
|
}
|
||||||
|
|
||||||
|
_check_if_is_git_repository() {
|
||||||
|
if [ -d ".git" ]; then
|
||||||
|
_log "debug" "Repository found.";
|
||||||
|
else
|
||||||
|
_log "error" "Not a git repository. Please make sure to run this action in a git repository. Adjust the `repository` input if necessary.";
|
||||||
exit 1;
|
exit 1;
|
||||||
fi
|
fi
|
||||||
[ -n "$gitStatus" ]
|
}
|
||||||
|
|
||||||
|
_check_if_repository_is_in_detached_state() {
|
||||||
|
if [ -z "$(git symbolic-ref HEAD)" ]
|
||||||
|
then
|
||||||
|
_log "warning" "Repository is in a detached HEAD state. git-auto-commit will likely handle this automatically. To avoid it, check out a branch using the ref option in actions/checkout.";
|
||||||
|
else
|
||||||
|
_log "debug" "Repository is on a branch.";
|
||||||
|
fi
|
||||||
}
|
}
|
||||||
|
|
||||||
_switch_to_branch() {
|
_switch_to_branch() {
|
||||||
@@ -100,6 +123,7 @@ _switch_to_branch() {
|
|||||||
if "$INPUT_SKIP_FETCH"; then
|
if "$INPUT_SKIP_FETCH"; then
|
||||||
_log "debug" "git-fetch will not be executed.";
|
_log "debug" "git-fetch will not be executed.";
|
||||||
else
|
else
|
||||||
|
_log "debug" "git-fetch will be executed.";
|
||||||
git fetch --depth=1;
|
git fetch --depth=1;
|
||||||
fi
|
fi
|
||||||
|
|
||||||
@@ -107,6 +131,7 @@ _switch_to_branch() {
|
|||||||
if "$INPUT_SKIP_CHECKOUT"; then
|
if "$INPUT_SKIP_CHECKOUT"; then
|
||||||
_log "debug" "git-checkout will not be executed.";
|
_log "debug" "git-checkout will not be executed.";
|
||||||
else
|
else
|
||||||
|
_log "debug" "git-checkout will be executed.";
|
||||||
# Create new local branch if `create_branch`-input is true
|
# Create new local branch if `create_branch`-input is true
|
||||||
if "$INPUT_CREATE_BRANCH"; then
|
if "$INPUT_CREATE_BRANCH"; then
|
||||||
# shellcheck disable=SC2086
|
# shellcheck disable=SC2086
|
||||||
@@ -164,6 +189,8 @@ _tag_commit() {
|
|||||||
|
|
||||||
_push_to_github() {
|
_push_to_github() {
|
||||||
|
|
||||||
|
echo "INPUT_BRANCH value: $INPUT_BRANCH";
|
||||||
|
|
||||||
echo "INPUT_PUSH_OPTIONS: ${INPUT_PUSH_OPTIONS}";
|
echo "INPUT_PUSH_OPTIONS: ${INPUT_PUSH_OPTIONS}";
|
||||||
_log "debug" "Apply push options ${INPUT_PUSH_OPTIONS}";
|
_log "debug" "Apply push options ${INPUT_PUSH_OPTIONS}";
|
||||||
|
|
||||||
|
|||||||
37
package-lock.json
generated
Normal file
37
package-lock.json
generated
Normal file
@@ -0,0 +1,37 @@
|
|||||||
|
{
|
||||||
|
"name": "git-auto-commit-action",
|
||||||
|
"lockfileVersion": 3,
|
||||||
|
"requires": true,
|
||||||
|
"packages": {
|
||||||
|
"": {
|
||||||
|
"devDependencies": {
|
||||||
|
"bats": "^1.12.0",
|
||||||
|
"bats-assert": "ztombol/bats-assert",
|
||||||
|
"bats-support": "ztombol/bats-support"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/bats": {
|
||||||
|
"version": "1.12.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/bats/-/bats-1.12.0.tgz",
|
||||||
|
"integrity": "sha512-1HTv2n+fjn3bmY9SNDgmzS6bjoKtVlSK2pIHON5aSA2xaqGkZFoCCWP46/G6jm9zZ7MCi84mD+3Byw4t3KGwBg==",
|
||||||
|
"dev": true,
|
||||||
|
"license": "MIT",
|
||||||
|
"bin": {
|
||||||
|
"bats": "bin/bats"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/bats-assert": {
|
||||||
|
"version": "0.3.0",
|
||||||
|
"resolved": "git+ssh://git@github.com/ztombol/bats-assert.git#9f88b4207da750093baabc4e3f41bf68f0dd3630",
|
||||||
|
"dev": true,
|
||||||
|
"peerDependencies": {
|
||||||
|
"bats-support": "git+https://github.com/ztombol/bats-support.git#v0.2.0"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/bats-support": {
|
||||||
|
"version": "0.3.0",
|
||||||
|
"resolved": "git+ssh://git@github.com/ztombol/bats-support.git#004e707638eedd62e0481e8cdc9223ad471f12ee",
|
||||||
|
"dev": true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"bats": "^1.11.0",
|
"bats": "^1.12.0",
|
||||||
"bats-assert": "ztombol/bats-assert",
|
"bats-assert": "ztombol/bats-assert",
|
||||||
"bats-support": "ztombol/bats-support"
|
"bats-support": "ztombol/bats-support"
|
||||||
},
|
},
|
||||||
|
|||||||
@@ -21,6 +21,7 @@ setup() {
|
|||||||
export FAKE_DEFAULT_BRANCH=$(git config init.defaultBranch)
|
export FAKE_DEFAULT_BRANCH=$(git config init.defaultBranch)
|
||||||
|
|
||||||
# Set default INPUT variables used by the GitHub Action
|
# Set default INPUT variables used by the GitHub Action
|
||||||
|
export INPUT_CREATE_GIT_TAG_ONLY=false
|
||||||
export INPUT_REPOSITORY="${FAKE_LOCAL_REPOSITORY}"
|
export INPUT_REPOSITORY="${FAKE_LOCAL_REPOSITORY}"
|
||||||
export INPUT_COMMIT_MESSAGE="Commit Message"
|
export INPUT_COMMIT_MESSAGE="Commit Message"
|
||||||
export INPUT_BRANCH="${FAKE_DEFAULT_BRANCH}"
|
export INPUT_BRANCH="${FAKE_DEFAULT_BRANCH}"
|
||||||
@@ -192,7 +193,6 @@ cat_github_output() {
|
|||||||
assert_failure
|
assert_failure
|
||||||
|
|
||||||
assert_line "INPUT_REPOSITORY value: ${INPUT_REPOSITORY}"
|
assert_line "INPUT_REPOSITORY value: ${INPUT_REPOSITORY}"
|
||||||
assert_line "INPUT_BRANCH value: ${FAKE_DEFAULT_BRANCH}"
|
|
||||||
assert_line "INPUT_FILE_PATTERN: ."
|
assert_line "INPUT_FILE_PATTERN: ."
|
||||||
assert_line "INPUT_COMMIT_OPTIONS: "
|
assert_line "INPUT_COMMIT_OPTIONS: "
|
||||||
assert_line "::debug::Apply commit options "
|
assert_line "::debug::Apply commit options "
|
||||||
@@ -578,6 +578,585 @@ cat_github_output() {
|
|||||||
assert_line "changes_detected=true"
|
assert_line "changes_detected=true"
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@test "It pushes commit to new branch that does not exist yet" {
|
||||||
|
INPUT_BRANCH="not-existend-branch"
|
||||||
|
|
||||||
|
run git branch
|
||||||
|
refute_line --partial "not-existend-branch"
|
||||||
|
|
||||||
|
run git branch -r
|
||||||
|
refute_line --partial "origin/not-existend-branch"
|
||||||
|
|
||||||
|
touch "${FAKE_LOCAL_REPOSITORY}"/new-file-{1,2,3}.txt
|
||||||
|
|
||||||
|
INPUT_SKIP_CHECKOUT=true
|
||||||
|
|
||||||
|
run git_auto_commit
|
||||||
|
|
||||||
|
assert_success
|
||||||
|
|
||||||
|
assert_line "INPUT_REPOSITORY value: ${INPUT_REPOSITORY}"
|
||||||
|
assert_line "INPUT_BRANCH value: not-existend-branch"
|
||||||
|
|
||||||
|
run git branch
|
||||||
|
assert_line --partial ${FAKE_DEFAULT_BRANCH}
|
||||||
|
refute_line --partial "not-existend-branch"
|
||||||
|
|
||||||
|
run git branch -r
|
||||||
|
assert_line --partial "origin/not-existend-branch"
|
||||||
|
|
||||||
|
run cat_github_output
|
||||||
|
assert_line "changes_detected=true"
|
||||||
|
}
|
||||||
|
|
||||||
|
@test "It does not create new local branch and pushes the commit to a new branch on remote" {
|
||||||
|
INPUT_BRANCH="not-existend-branch"
|
||||||
|
|
||||||
|
run git branch
|
||||||
|
refute_line --partial "not-existend-branch"
|
||||||
|
|
||||||
|
run git branch -r
|
||||||
|
refute_line --partial "origin/not-existend-branch"
|
||||||
|
|
||||||
|
touch "${FAKE_LOCAL_REPOSITORY}"/new-file-{1,2,3}.txt
|
||||||
|
|
||||||
|
INPUT_SKIP_CHECKOUT=true
|
||||||
|
|
||||||
|
run git_auto_commit
|
||||||
|
|
||||||
|
assert_success
|
||||||
|
|
||||||
|
assert_line "INPUT_REPOSITORY value: ${INPUT_REPOSITORY}"
|
||||||
|
assert_line "INPUT_BRANCH value: not-existend-branch"
|
||||||
|
assert_line "INPUT_FILE_PATTERN: ."
|
||||||
|
assert_line "INPUT_COMMIT_OPTIONS: "
|
||||||
|
assert_line "::debug::Apply commit options "
|
||||||
|
assert_line "INPUT_TAGGING_MESSAGE: "
|
||||||
|
assert_line "No tagging message supplied. No tag will be added."
|
||||||
|
assert_line "INPUT_PUSH_OPTIONS: "
|
||||||
|
assert_line "::debug::Apply push options "
|
||||||
|
assert_line "::debug::Push commit to remote branch not-existend-branch"
|
||||||
|
|
||||||
|
# Assert that local repo is still on default branch and not on new branch.
|
||||||
|
run git branch
|
||||||
|
assert_line --partial ${FAKE_DEFAULT_BRANCH}
|
||||||
|
refute_line --partial "not-existend-branch"
|
||||||
|
|
||||||
|
# Assert branch has been created on remote
|
||||||
|
run git branch -r
|
||||||
|
assert_line --partial "origin/not-existend-branch"
|
||||||
|
|
||||||
|
run cat_github_output
|
||||||
|
assert_line "changes_detected=true"
|
||||||
|
assert_line -e "commit_hash=[0-9a-f]{40}$"
|
||||||
|
}
|
||||||
|
|
||||||
|
@test "It creates new local branch and pushes branch to remote even if the remote branch already exists" {
|
||||||
|
# Create `existing-remote-branch` on remote with changes the local repository does not yet have
|
||||||
|
cd $FAKE_TEMP_LOCAL_REPOSITORY
|
||||||
|
git checkout -b "existing-remote-branch"
|
||||||
|
touch new-branch-file.txt
|
||||||
|
git add new-branch-file.txt
|
||||||
|
git commit -m "Add additional file"
|
||||||
|
git push origin existing-remote-branch
|
||||||
|
|
||||||
|
run git branch
|
||||||
|
assert_line --partial "existing-remote-branch"
|
||||||
|
|
||||||
|
# ---------
|
||||||
|
# Switch to our regular local repository and run `git-auto-commit`
|
||||||
|
cd $FAKE_LOCAL_REPOSITORY
|
||||||
|
|
||||||
|
INPUT_BRANCH="existing-remote-branch"
|
||||||
|
INPUT_SKIP_CHECKOUT=true
|
||||||
|
|
||||||
|
run git branch
|
||||||
|
refute_line --partial "existing-remote-branch"
|
||||||
|
|
||||||
|
run git fetch --all
|
||||||
|
run git pull origin existing-remote-branch
|
||||||
|
run git branch -r
|
||||||
|
assert_line --partial "origin/existing-remote-branch"
|
||||||
|
|
||||||
|
touch "${FAKE_LOCAL_REPOSITORY}"/new-file-{1,2,3}.txt
|
||||||
|
|
||||||
|
run git_auto_commit
|
||||||
|
|
||||||
|
assert_success
|
||||||
|
|
||||||
|
assert_line "INPUT_REPOSITORY value: ${INPUT_REPOSITORY}"
|
||||||
|
assert_line "INPUT_BRANCH value: existing-remote-branch"
|
||||||
|
assert_line "INPUT_FILE_PATTERN: ."
|
||||||
|
assert_line "INPUT_COMMIT_OPTIONS: "
|
||||||
|
assert_line "::debug::Apply commit options "
|
||||||
|
assert_line "INPUT_TAGGING_MESSAGE: "
|
||||||
|
assert_line "No tagging message supplied. No tag will be added."
|
||||||
|
assert_line "INPUT_PUSH_OPTIONS: "
|
||||||
|
assert_line "::debug::Apply push options "
|
||||||
|
assert_line "::debug::Push commit to remote branch existing-remote-branch"
|
||||||
|
|
||||||
|
run git branch
|
||||||
|
assert_line --partial ${FAKE_DEFAULT_BRANCH}
|
||||||
|
refute_line --partial "existing-remote-branch"
|
||||||
|
|
||||||
|
run git branch -r
|
||||||
|
assert_line --partial "origin/existing-remote-branch"
|
||||||
|
|
||||||
|
# Assert that branch "existing-remote-branch" was updated on remote
|
||||||
|
current_sha="$(git rev-parse --verify --short ${FAKE_DEFAULT_BRANCH})"
|
||||||
|
remote_sha="$(git rev-parse --verify --short origin/existing-remote-branch)"
|
||||||
|
|
||||||
|
assert_equal $current_sha $remote_sha
|
||||||
|
|
||||||
|
run cat_github_output
|
||||||
|
assert_line "changes_detected=true"
|
||||||
|
assert_line -e "commit_hash=[0-9a-f]{40}$"
|
||||||
|
}
|
||||||
|
|
||||||
|
@test "It fails if local branch is behind remote and when remote has newer commits and skip_checkout is set to true" {
|
||||||
|
# Create `existing-remote-branch` on remote with changes the local repository does not yet have
|
||||||
|
cd $FAKE_TEMP_LOCAL_REPOSITORY
|
||||||
|
git checkout -b "existing-remote-branch"
|
||||||
|
touch new-branch-file.txt
|
||||||
|
git add new-branch-file.txt
|
||||||
|
git commit -m "Add additional file"
|
||||||
|
git push origin existing-remote-branch
|
||||||
|
|
||||||
|
run git branch
|
||||||
|
assert_line --partial "existing-remote-branch"
|
||||||
|
|
||||||
|
# ---------
|
||||||
|
# Switch to our regular local repository and run `git-auto-commit`
|
||||||
|
cd $FAKE_LOCAL_REPOSITORY
|
||||||
|
|
||||||
|
INPUT_BRANCH="existing-remote-branch"
|
||||||
|
INPUT_SKIP_CHECKOUT=true
|
||||||
|
|
||||||
|
run git branch
|
||||||
|
refute_line --partial "existing-remote-branch"
|
||||||
|
|
||||||
|
run git fetch --all
|
||||||
|
run git branch -r
|
||||||
|
assert_line --partial "origin/existing-remote-branch"
|
||||||
|
|
||||||
|
touch "${FAKE_LOCAL_REPOSITORY}"/new-file-{1,2,3}.txt
|
||||||
|
|
||||||
|
run git_auto_commit
|
||||||
|
|
||||||
|
assert_failure
|
||||||
|
|
||||||
|
assert_line "hint: Updates were rejected because a pushed branch tip is behind its remote"
|
||||||
|
|
||||||
|
# Assert that branch exists locally and on remote
|
||||||
|
run git branch
|
||||||
|
assert_line --partial ${FAKE_DEFAULT_BRANCH}
|
||||||
|
refute_line --partial "existing-remote-branch"
|
||||||
|
|
||||||
|
run git branch -r
|
||||||
|
assert_line --partial "origin/existing-remote-branch"
|
||||||
|
|
||||||
|
# Assert that branch "existing-remote-branch" was not updated on remote
|
||||||
|
current_sha="$(git rev-parse --verify --short ${FAKE_DEFAULT_BRANCH})"
|
||||||
|
remote_sha="$(git rev-parse --verify --short origin/existing-remote-branch)"
|
||||||
|
|
||||||
|
refute [assert_equal $current_sha $remote_sha]
|
||||||
|
}
|
||||||
|
|
||||||
|
@test "It fails to push commit to remote if branch already exists and local repo is behind its remote counterpart and SKIP_CHECKOUT is used" {
|
||||||
|
# Create `new-branch` on remote with changes the local repository does not yet have
|
||||||
|
cd $FAKE_TEMP_LOCAL_REPOSITORY
|
||||||
|
|
||||||
|
git checkout -b "new-branch"
|
||||||
|
touch new-branch-file.txt
|
||||||
|
git add new-branch-file.txt
|
||||||
|
|
||||||
|
git commit --quiet -m "Add additional file"
|
||||||
|
git push origin new-branch
|
||||||
|
|
||||||
|
run git branch -r
|
||||||
|
assert_line --partial "origin/new-branch"
|
||||||
|
|
||||||
|
# ---------
|
||||||
|
# Switch to our regular local repository and run `git-auto-commit`
|
||||||
|
cd $FAKE_LOCAL_REPOSITORY
|
||||||
|
|
||||||
|
INPUT_BRANCH="new-branch"
|
||||||
|
INPUT_SKIP_CHECKOUT=true
|
||||||
|
|
||||||
|
# Assert that local remote does not have a "new-branch"-branch nor does
|
||||||
|
# know about the remote branch.
|
||||||
|
run git branch
|
||||||
|
refute_line --partial "new-branch"
|
||||||
|
|
||||||
|
run git branch -r
|
||||||
|
refute_line --partial "origin/new-branch"
|
||||||
|
|
||||||
|
touch "${FAKE_LOCAL_REPOSITORY}"/new-file-{1,2,3}.txt
|
||||||
|
|
||||||
|
run git_auto_commit
|
||||||
|
|
||||||
|
assert_failure
|
||||||
|
|
||||||
|
assert_line "INPUT_BRANCH value: new-branch"
|
||||||
|
assert_line --partial "::debug::Push commit to remote branch new-branch"
|
||||||
|
|
||||||
|
assert_line --partial "Updates were rejected because a pushed branch tip is behind its remote"
|
||||||
|
}
|
||||||
|
|
||||||
|
@test "throws fatal error if file pattern includes files that do not exist" {
|
||||||
|
touch "${FAKE_LOCAL_REPOSITORY}"/new-file-{1,2,3}.foo
|
||||||
|
|
||||||
|
INPUT_FILE_PATTERN="*.foo *.bar"
|
||||||
|
|
||||||
|
run git_auto_commit
|
||||||
|
|
||||||
|
assert_failure
|
||||||
|
assert_line --partial "fatal: pathspec '*.bar' did not match any files"
|
||||||
|
}
|
||||||
|
|
||||||
|
@test "does not throw fatal error if files for file pattern exist but only one is dirty" {
|
||||||
|
# Add some .foo and .bar files
|
||||||
|
touch "${FAKE_LOCAL_REPOSITORY}"/new-file-{1,2,3}.foo
|
||||||
|
touch "${FAKE_LOCAL_REPOSITORY}"/new-file-{1,2,3}.bar
|
||||||
|
|
||||||
|
INPUT_FILE_PATTERN="*.foo *.bar"
|
||||||
|
|
||||||
|
run git_auto_commit
|
||||||
|
|
||||||
|
# Add more .foo files
|
||||||
|
touch "${FAKE_LOCAL_REPOSITORY}"/new-file-{4,5,6}.foo
|
||||||
|
|
||||||
|
INPUT_FILE_PATTERN="*.foo *.bar"
|
||||||
|
|
||||||
|
run git_auto_commit
|
||||||
|
|
||||||
|
assert_success
|
||||||
|
}
|
||||||
|
|
||||||
|
@test "detects and commits changed files based on pattern in root and subfolders" {
|
||||||
|
# Add some .neon files
|
||||||
|
touch "${FAKE_LOCAL_REPOSITORY}"/new-file-1.neon
|
||||||
|
mkdir foo
|
||||||
|
touch "${FAKE_LOCAL_REPOSITORY}"/foo/new-file-2.neon
|
||||||
|
|
||||||
|
INPUT_FILE_PATTERN="**/*.neon *.neon"
|
||||||
|
|
||||||
|
run git_auto_commit
|
||||||
|
|
||||||
|
assert_success
|
||||||
|
|
||||||
|
assert_line --partial "new-file-1.neon"
|
||||||
|
assert_line --partial "foo/new-file-2.neon"
|
||||||
|
}
|
||||||
|
|
||||||
|
@test "throws error if tries to force add ignored files which do not have any changes" {
|
||||||
|
# Create 2 files which will later will be added to .gitignore
|
||||||
|
touch "${FAKE_LOCAL_REPOSITORY}"/ignored-file.txt
|
||||||
|
touch "${FAKE_LOCAL_REPOSITORY}"/another-ignored-file.txt
|
||||||
|
|
||||||
|
# Commit the 2 new files
|
||||||
|
run git_auto_commit
|
||||||
|
|
||||||
|
# Add our txt files to gitignore
|
||||||
|
echo "ignored-file.txt" >>"${FAKE_LOCAL_REPOSITORY}"/.gitignore
|
||||||
|
echo "another-ignored-file.txt" >>"${FAKE_LOCAL_REPOSITORY}"/.gitignore
|
||||||
|
|
||||||
|
# Commit & push .gitignore changes
|
||||||
|
run git_auto_commit
|
||||||
|
|
||||||
|
# Sanity check that txt files are ignored
|
||||||
|
run cat "${FAKE_LOCAL_REPOSITORY}"/.gitignore
|
||||||
|
assert_output --partial "ignored-file.txt"
|
||||||
|
assert_output --partial "another-ignored-file.txt"
|
||||||
|
|
||||||
|
# Configure git-auto-commit
|
||||||
|
INPUT_SKIP_DIRTY_CHECK=true
|
||||||
|
INPUT_ADD_OPTIONS="-f"
|
||||||
|
INPUT_FILE_PATTERN="ignored-file.txt another-ignored-file.txt"
|
||||||
|
|
||||||
|
# Run git-auto-commit with special configuration
|
||||||
|
run git_auto_commit
|
||||||
|
|
||||||
|
assert_output --partial "nothing to commit, working tree clean"
|
||||||
|
|
||||||
|
assert_failure
|
||||||
|
}
|
||||||
|
|
||||||
|
@test "expands file patterns correctly and commits all changed files" {
|
||||||
|
# Add more .txt files
|
||||||
|
touch "${FAKE_LOCAL_REPOSITORY}"/new-file-1.txt
|
||||||
|
mkdir "${FAKE_LOCAL_REPOSITORY}"/subdirectory/
|
||||||
|
touch "${FAKE_LOCAL_REPOSITORY}"/subdirectory/new-file-2.txt
|
||||||
|
touch "${FAKE_LOCAL_REPOSITORY}"/new-file-3.bar
|
||||||
|
|
||||||
|
INPUT_FILE_PATTERN="*.txt *.bar"
|
||||||
|
|
||||||
|
run git_auto_commit
|
||||||
|
|
||||||
|
assert_success
|
||||||
|
|
||||||
|
assert_line --partial "new-file-1.txt"
|
||||||
|
assert_line --partial "subdirectory/new-file-2.txt"
|
||||||
|
assert_line --partial "new-file-3.bar"
|
||||||
|
}
|
||||||
|
|
||||||
|
@test "expands file patterns correctly and commits all changed files when globbing is disabled" {
|
||||||
|
# Add more .txt files
|
||||||
|
touch "${FAKE_LOCAL_REPOSITORY}"/new-file-1.txt
|
||||||
|
mkdir "${FAKE_LOCAL_REPOSITORY}"/subdirectory/
|
||||||
|
touch "${FAKE_LOCAL_REPOSITORY}"/subdirectory/new-file-2.txt
|
||||||
|
touch "${FAKE_LOCAL_REPOSITORY}"/new-file-3.bar
|
||||||
|
|
||||||
|
INPUT_FILE_PATTERN="*.txt *.bar"
|
||||||
|
INPUT_DISABLE_GLOBBING=true
|
||||||
|
|
||||||
|
run git_auto_commit
|
||||||
|
|
||||||
|
assert_success
|
||||||
|
|
||||||
|
assert_line --partial "new-file-1.txt"
|
||||||
|
assert_line --partial "subdirectory/new-file-2.txt"
|
||||||
|
assert_line --partial "new-file-3.bar"
|
||||||
|
}
|
||||||
|
|
||||||
|
@test "expands file patterns correctly and commits all changed files if dirty files are only in subdirectory" {
|
||||||
|
# Add more .txt files
|
||||||
|
mkdir "${FAKE_LOCAL_REPOSITORY}"/subdirectory/
|
||||||
|
touch "${FAKE_LOCAL_REPOSITORY}"/subdirectory/new-file-2.txt
|
||||||
|
mkdir "${FAKE_LOCAL_REPOSITORY}"/another-subdirectory/
|
||||||
|
touch "${FAKE_LOCAL_REPOSITORY}"/another-subdirectory/new-file-3.txt
|
||||||
|
|
||||||
|
INPUT_FILE_PATTERN="*.txt"
|
||||||
|
INPUT_DISABLE_GLOBBING=true
|
||||||
|
|
||||||
|
run git_auto_commit
|
||||||
|
|
||||||
|
assert_success
|
||||||
|
|
||||||
|
assert_line --partial "subdirectory/new-file-2.txt"
|
||||||
|
assert_line --partial "another-subdirectory/new-file-3.txt"
|
||||||
|
}
|
||||||
|
|
||||||
|
@test "detects if crlf in files change and does not create commit" {
|
||||||
|
# Set autocrlf to true
|
||||||
|
cd "${FAKE_LOCAL_REPOSITORY}"
|
||||||
|
git config core.autocrlf true
|
||||||
|
run git config --get-all core.autocrlf
|
||||||
|
assert_line "true"
|
||||||
|
|
||||||
|
# Add more .txt files
|
||||||
|
echo -ne "crlf test1\r\n" > "${FAKE_LOCAL_REPOSITORY}"/new-file-2.txt
|
||||||
|
echo -ne "crlf test1\n" > "${FAKE_LOCAL_REPOSITORY}"/new-file-3.txt
|
||||||
|
|
||||||
|
# Run git-auto-commit to add new files to repository
|
||||||
|
run git_auto_commit
|
||||||
|
|
||||||
|
# Change control characters in files
|
||||||
|
echo -ne "crlf test1\n" > "${FAKE_LOCAL_REPOSITORY}"/new-file-2.txt
|
||||||
|
echo -ne "crlf test1\r\n" > "${FAKE_LOCAL_REPOSITORY}"/new-file-3.txt
|
||||||
|
|
||||||
|
# Run git-auto-commit to commit the 2 changes files
|
||||||
|
run git_auto_commit
|
||||||
|
|
||||||
|
assert_success
|
||||||
|
|
||||||
|
refute_line --partial "2 files changed, 2 insertions(+), 2 deletions(-)"
|
||||||
|
assert_line --partial "warning: in the working copy of 'new-file-2.txt', LF will be replaced by CRLF the next time Git touches it"
|
||||||
|
|
||||||
|
assert_line --partial "Working tree clean. Nothing to commit."
|
||||||
|
assert_line --partial "new-file-2.txt"
|
||||||
|
# assert_line --partial "new-file-3.txt"
|
||||||
|
|
||||||
|
# Changes are not detected
|
||||||
|
run cat_github_output
|
||||||
|
assert_line "changes_detected=false"
|
||||||
|
}
|
||||||
|
|
||||||
|
@test "detects if crlf in files change and creates commit if the actual content of the files change" {
|
||||||
|
# Set autocrlf to true
|
||||||
|
cd "${FAKE_LOCAL_REPOSITORY}"
|
||||||
|
git config core.autocrlf true
|
||||||
|
run git config --get-all core.autocrlf
|
||||||
|
assert_line "true"
|
||||||
|
|
||||||
|
# Add more .txt files
|
||||||
|
echo -ne "crlf test1\r\n" > "${FAKE_LOCAL_REPOSITORY}"/new-file-2.txt
|
||||||
|
echo -ne "crlf test1\n" > "${FAKE_LOCAL_REPOSITORY}"/new-file-3.txt
|
||||||
|
|
||||||
|
# Run git-auto-commit to add new files to repository
|
||||||
|
run git_auto_commit
|
||||||
|
|
||||||
|
# Change control characters in files
|
||||||
|
echo -ne "crlf test2\n" > "${FAKE_LOCAL_REPOSITORY}"/new-file-2.txt
|
||||||
|
echo -ne "crlf test2\r\n" > "${FAKE_LOCAL_REPOSITORY}"/new-file-3.txt
|
||||||
|
|
||||||
|
# Run git-auto-commit to commit the 2 changes files
|
||||||
|
run git_auto_commit
|
||||||
|
|
||||||
|
assert_success
|
||||||
|
|
||||||
|
assert_line --partial "2 files changed, 2 insertions(+), 2 deletions(-)"
|
||||||
|
assert_line --partial "warning: in the working copy of 'new-file-2.txt', LF will be replaced by CRLF the next time Git touches it"
|
||||||
|
|
||||||
|
assert_line --partial "new-file-2.txt"
|
||||||
|
# assert_line --partial "new-file-3.txt"
|
||||||
|
|
||||||
|
# Changes are detected
|
||||||
|
run cat_github_output
|
||||||
|
assert_line "changes_detected=true"
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
@test "It uses old set-output syntax if GITHUB_OUTPUT environment is not available when changes are committed" {
|
||||||
|
unset GITHUB_OUTPUT
|
||||||
|
|
||||||
|
touch "${FAKE_LOCAL_REPOSITORY}"/new-file-{1,2,3}.txt
|
||||||
|
|
||||||
|
run git_auto_commit
|
||||||
|
|
||||||
|
assert_success
|
||||||
|
|
||||||
|
assert_line "INPUT_REPOSITORY value: ${INPUT_REPOSITORY}"
|
||||||
|
assert_line "INPUT_BRANCH value: ${FAKE_DEFAULT_BRANCH}"
|
||||||
|
assert_line "INPUT_FILE_PATTERN: ."
|
||||||
|
assert_line "INPUT_COMMIT_OPTIONS: "
|
||||||
|
assert_line "::debug::Apply commit options "
|
||||||
|
assert_line "INPUT_TAGGING_MESSAGE: "
|
||||||
|
assert_line "No tagging message supplied. No tag will be added."
|
||||||
|
assert_line "INPUT_PUSH_OPTIONS: "
|
||||||
|
assert_line "::debug::Apply push options "
|
||||||
|
assert_line "::debug::Push commit to remote branch ${FAKE_DEFAULT_BRANCH}"
|
||||||
|
|
||||||
|
assert_line "::set-output name=changes_detected::true"
|
||||||
|
assert_line -e "::set-output name=commit_hash::[0-9a-f]{40}$"
|
||||||
|
}
|
||||||
|
|
||||||
|
@test "It uses old set-output syntax if GITHUB_OUTPUT environment is not available when no changes have been detected" {
|
||||||
|
unset GITHUB_OUTPUT
|
||||||
|
|
||||||
|
run git_auto_commit
|
||||||
|
|
||||||
|
assert_success
|
||||||
|
|
||||||
|
assert_line "INPUT_REPOSITORY value: ${INPUT_REPOSITORY}"
|
||||||
|
assert_line "Working tree clean. Nothing to commit."
|
||||||
|
|
||||||
|
assert_line "::set-output name=changes_detected::false"
|
||||||
|
refute_line -e "::set-output name=commit_hash::[0-9a-f]{40}$"
|
||||||
|
}
|
||||||
|
|
||||||
|
@test "It fails hard if git is not available" {
|
||||||
|
INPUT_INTERNAL_GIT_BINARY=binary-does-not-exist
|
||||||
|
|
||||||
|
touch "${FAKE_LOCAL_REPOSITORY}"/new-file-{1,2,3}.txt
|
||||||
|
|
||||||
|
run git_auto_commit
|
||||||
|
|
||||||
|
assert_failure;
|
||||||
|
assert_line "::error::git-auto-commit could not find git binary. Please make sure git is available."
|
||||||
|
}
|
||||||
|
|
||||||
|
@test "It creates multi-line commit messages" {
|
||||||
|
touch "${FAKE_LOCAL_REPOSITORY}"/new-file-{1,2,3}.txt
|
||||||
|
|
||||||
|
COMMIT_MESSAGE=$(cat <<-END
|
||||||
|
this commit message
|
||||||
|
has multiple lines
|
||||||
|
END
|
||||||
|
)
|
||||||
|
|
||||||
|
INPUT_COMMIT_MESSAGE=$COMMIT_MESSAGE
|
||||||
|
|
||||||
|
run git_auto_commit
|
||||||
|
|
||||||
|
assert_success
|
||||||
|
|
||||||
|
# Assert last commit was signed off
|
||||||
|
run git log -n 1
|
||||||
|
assert_output --partial $COMMIT_MESSAGE
|
||||||
|
}
|
||||||
|
|
||||||
|
@test "It exits with error message if entrypoint.sh is being run not in a git repository" {
|
||||||
|
INPUT_REPOSITORY="${FAKE_FOLDER_WITHOUT_GIT_REPO}"
|
||||||
|
|
||||||
|
mkdir "${INPUT_REPOSITORY}"
|
||||||
|
|
||||||
|
run git_auto_commit
|
||||||
|
|
||||||
|
assert_failure;
|
||||||
|
assert_line "::error::Not a git repository. Please make sure to run this action in a git repository. Adjust the `repository` input if necessary."
|
||||||
|
}
|
||||||
|
|
||||||
|
@test "It detects if the repository is in a detached state and logs a warning" {
|
||||||
|
touch "${FAKE_LOCAL_REPOSITORY}"/new-file-{1,2,3}.txt
|
||||||
|
|
||||||
|
run git_auto_commit
|
||||||
|
|
||||||
|
assert_success
|
||||||
|
|
||||||
|
# Bring local repository into a detached state
|
||||||
|
prev_commit=$(git rev-parse HEAD~1);
|
||||||
|
git checkout "$prev_commit";
|
||||||
|
|
||||||
|
touch "${FAKE_TEMP_LOCAL_REPOSITORY}"/remote-files{4,5,6}.txt
|
||||||
|
|
||||||
|
run git_auto_commit
|
||||||
|
|
||||||
|
assert_success;
|
||||||
|
assert_line "::warning::Repository is in a detached HEAD state. git-auto-commit will likely handle this automatically. To avoid it, check out a branch using the ref option in actions/checkout."
|
||||||
|
}
|
||||||
|
|
||||||
|
@test "it creates a tag if create_git_tag_only is set to true and a message has been supplied" {
|
||||||
|
INPUT_CREATE_GIT_TAG_ONLY=true
|
||||||
|
INPUT_TAGGING_MESSAGE=v1.0.0
|
||||||
|
|
||||||
|
run git_auto_commit
|
||||||
|
|
||||||
|
assert_success
|
||||||
|
|
||||||
|
assert_line "::debug::Create git tag only"
|
||||||
|
|
||||||
|
assert_line "::debug::Create tag v1.0.0"
|
||||||
|
refute_line "No tagging message supplied. No tag will be added."
|
||||||
|
|
||||||
|
assert_line "::debug::Apply push options "
|
||||||
|
assert_line "::debug::Push commit to remote branch ${FAKE_DEFAULT_BRANCH}"
|
||||||
|
|
||||||
|
run cat_github_output
|
||||||
|
assert_line "create_git_tag_only=true"
|
||||||
|
refute_line "changes_detected=false"
|
||||||
|
refute_line -e "commit_hash=[0-9a-f]{40}$"
|
||||||
|
|
||||||
|
# Assert a tag v1.0.0 has been created
|
||||||
|
run git tag
|
||||||
|
assert_output v1.0.0
|
||||||
|
|
||||||
|
run git ls-remote --tags --refs
|
||||||
|
assert_output --partial refs/tags/v1.0.0
|
||||||
|
}
|
||||||
|
|
||||||
|
@test "it output no tagging message supplied if no tagging message is set but create_git_tag_only is set to true" {
|
||||||
|
INPUT_CREATE_GIT_TAG_ONLY=true
|
||||||
|
INPUT_TAGGING_MESSAGE=""
|
||||||
|
|
||||||
|
run git_auto_commit
|
||||||
|
|
||||||
|
assert_success
|
||||||
|
|
||||||
|
assert_line "INPUT_TAGGING_MESSAGE: "
|
||||||
|
assert_line "No tagging message supplied. No tag will be added."
|
||||||
|
assert_line "::debug::Create git tag only"
|
||||||
|
|
||||||
|
run cat_github_output
|
||||||
|
assert_line "create_git_tag_only=true"
|
||||||
|
refute_line "changes_detected=false"
|
||||||
|
refute_line -e "commit_hash=[0-9a-f]{40}$"
|
||||||
|
|
||||||
|
# Assert no tag has been created
|
||||||
|
run git tag
|
||||||
|
assert_output ""
|
||||||
|
}
|
||||||
|
|
||||||
@test "script fails to push commit to new branch that does not exist yet" {
|
@test "script fails to push commit to new branch that does not exist yet" {
|
||||||
INPUT_BRANCH="not-existend-branch"
|
INPUT_BRANCH="not-existend-branch"
|
||||||
INPUT_CREATE_BRANCH=false
|
INPUT_CREATE_BRANCH=false
|
||||||
@@ -646,13 +1225,12 @@ cat_github_output() {
|
|||||||
assert_line -e "commit_hash=[0-9a-f]{40}$"
|
assert_line -e "commit_hash=[0-9a-f]{40}$"
|
||||||
}
|
}
|
||||||
|
|
||||||
@test "it does not create new local branch if local branch already exists" {
|
@test "It does not create new local branch if local branch already exists and SKIP_CHECKOUT is true" {
|
||||||
|
|
||||||
git checkout -b not-existend-remote-branch
|
git checkout -b not-existend-remote-branch
|
||||||
git checkout ${FAKE_DEFAULT_BRANCH}
|
git checkout ${FAKE_DEFAULT_BRANCH}
|
||||||
|
|
||||||
INPUT_BRANCH="not-existend-remote-branch"
|
INPUT_BRANCH="not-existend-remote-branch"
|
||||||
INPUT_CREATE_BRANCH=true
|
INPUT_SKIP_CHECKOUT=true
|
||||||
|
|
||||||
run git branch
|
run git branch
|
||||||
assert_line --partial "not-existend-remote-branch"
|
assert_line --partial "not-existend-remote-branch"
|
||||||
@@ -677,6 +1255,11 @@ cat_github_output() {
|
|||||||
assert_line "::debug::Apply push options "
|
assert_line "::debug::Apply push options "
|
||||||
assert_line "::debug::Push commit to remote branch not-existend-remote-branch"
|
assert_line "::debug::Push commit to remote branch not-existend-remote-branch"
|
||||||
|
|
||||||
|
# Assert checked out branch is still the same.
|
||||||
|
run git rev-parse --abbrev-ref HEAD
|
||||||
|
assert_line --partial ${FAKE_DEFAULT_BRANCH}
|
||||||
|
refute_line --partial "not-existend-remote-branch"
|
||||||
|
|
||||||
run git branch
|
run git branch
|
||||||
assert_line --partial "not-existend-remote-branch"
|
assert_line --partial "not-existend-remote-branch"
|
||||||
|
|
||||||
@@ -841,287 +1424,3 @@ cat_github_output() {
|
|||||||
|
|
||||||
assert_equal $current_sha $remote_sha
|
assert_equal $current_sha $remote_sha
|
||||||
}
|
}
|
||||||
|
|
||||||
@test "throws fatal error if file pattern includes files that do not exist" {
|
|
||||||
touch "${FAKE_LOCAL_REPOSITORY}"/new-file-{1,2,3}.foo
|
|
||||||
|
|
||||||
INPUT_FILE_PATTERN="*.foo *.bar"
|
|
||||||
|
|
||||||
run git_auto_commit
|
|
||||||
|
|
||||||
assert_failure
|
|
||||||
assert_line --partial "fatal: pathspec '*.bar' did not match any files"
|
|
||||||
}
|
|
||||||
|
|
||||||
@test "does not throw fatal error if files for file pattern exist but only one is dirty" {
|
|
||||||
# Add some .foo and .bar files
|
|
||||||
touch "${FAKE_LOCAL_REPOSITORY}"/new-file-{1,2,3}.foo
|
|
||||||
touch "${FAKE_LOCAL_REPOSITORY}"/new-file-{1,2,3}.bar
|
|
||||||
|
|
||||||
INPUT_FILE_PATTERN="*.foo *.bar"
|
|
||||||
|
|
||||||
run git_auto_commit
|
|
||||||
|
|
||||||
# Add more .foo files
|
|
||||||
touch "${FAKE_LOCAL_REPOSITORY}"/new-file-{4,5,6}.foo
|
|
||||||
|
|
||||||
INPUT_FILE_PATTERN="*.foo *.bar"
|
|
||||||
|
|
||||||
run git_auto_commit
|
|
||||||
|
|
||||||
assert_success
|
|
||||||
}
|
|
||||||
|
|
||||||
@test "detects and commits changed files based on pattern in root and subfolders" {
|
|
||||||
# Add some .neon files
|
|
||||||
touch "${FAKE_LOCAL_REPOSITORY}"/new-file-1.neon
|
|
||||||
mkdir foo
|
|
||||||
touch "${FAKE_LOCAL_REPOSITORY}"/foo/new-file-2.neon
|
|
||||||
|
|
||||||
INPUT_FILE_PATTERN="**/*.neon *.neon"
|
|
||||||
|
|
||||||
run git_auto_commit
|
|
||||||
|
|
||||||
assert_success
|
|
||||||
|
|
||||||
assert_line --partial "new-file-1.neon"
|
|
||||||
assert_line --partial "foo/new-file-2.neon"
|
|
||||||
}
|
|
||||||
|
|
||||||
@test "throws error if tries to force add ignored files which do not have any changes" {
|
|
||||||
# Create 2 files which will later will be added to .gitignore
|
|
||||||
touch "${FAKE_LOCAL_REPOSITORY}"/ignored-file.txt
|
|
||||||
touch "${FAKE_LOCAL_REPOSITORY}"/another-ignored-file.txt
|
|
||||||
|
|
||||||
# Commit the 2 new files
|
|
||||||
run git_auto_commit
|
|
||||||
|
|
||||||
# Add our txt files to gitignore
|
|
||||||
echo "ignored-file.txt" >>"${FAKE_LOCAL_REPOSITORY}"/.gitignore
|
|
||||||
echo "another-ignored-file.txt" >>"${FAKE_LOCAL_REPOSITORY}"/.gitignore
|
|
||||||
|
|
||||||
# Commit & push .gitignore changes
|
|
||||||
run git_auto_commit
|
|
||||||
|
|
||||||
# Sanity check that txt files are ignored
|
|
||||||
run cat "${FAKE_LOCAL_REPOSITORY}"/.gitignore
|
|
||||||
assert_output --partial "ignored-file.txt"
|
|
||||||
assert_output --partial "another-ignored-file.txt"
|
|
||||||
|
|
||||||
# Configure git-auto-commit
|
|
||||||
INPUT_SKIP_DIRTY_CHECK=true
|
|
||||||
INPUT_ADD_OPTIONS="-f"
|
|
||||||
INPUT_FILE_PATTERN="ignored-file.txt another-ignored-file.txt"
|
|
||||||
|
|
||||||
# Run git-auto-commit with special configuration
|
|
||||||
run git_auto_commit
|
|
||||||
|
|
||||||
assert_output --partial "nothing to commit, working tree clean"
|
|
||||||
|
|
||||||
assert_failure
|
|
||||||
}
|
|
||||||
|
|
||||||
@test "expands file patterns correctly and commits all changed files" {
|
|
||||||
# Add more .txt files
|
|
||||||
touch "${FAKE_LOCAL_REPOSITORY}"/new-file-1.txt
|
|
||||||
mkdir "${FAKE_LOCAL_REPOSITORY}"/subdirectory/
|
|
||||||
touch "${FAKE_LOCAL_REPOSITORY}"/subdirectory/new-file-2.txt
|
|
||||||
touch "${FAKE_LOCAL_REPOSITORY}"/new-file-3.bar
|
|
||||||
|
|
||||||
INPUT_FILE_PATTERN="*.txt *.bar"
|
|
||||||
|
|
||||||
run git_auto_commit
|
|
||||||
|
|
||||||
assert_success
|
|
||||||
|
|
||||||
assert_line --partial "new-file-1.txt"
|
|
||||||
assert_line --partial "subdirectory/new-file-2.txt"
|
|
||||||
assert_line --partial "new-file-3.bar"
|
|
||||||
}
|
|
||||||
|
|
||||||
@test "expands file patterns correctly and commits all changed files when globbing is disabled" {
|
|
||||||
# Add more .txt files
|
|
||||||
touch "${FAKE_LOCAL_REPOSITORY}"/new-file-1.txt
|
|
||||||
mkdir "${FAKE_LOCAL_REPOSITORY}"/subdirectory/
|
|
||||||
touch "${FAKE_LOCAL_REPOSITORY}"/subdirectory/new-file-2.txt
|
|
||||||
touch "${FAKE_LOCAL_REPOSITORY}"/new-file-3.bar
|
|
||||||
|
|
||||||
INPUT_FILE_PATTERN="*.txt *.bar"
|
|
||||||
INPUT_DISABLE_GLOBBING=true
|
|
||||||
|
|
||||||
run git_auto_commit
|
|
||||||
|
|
||||||
assert_success
|
|
||||||
|
|
||||||
assert_line --partial "new-file-1.txt"
|
|
||||||
assert_line --partial "subdirectory/new-file-2.txt"
|
|
||||||
assert_line --partial "new-file-3.bar"
|
|
||||||
}
|
|
||||||
|
|
||||||
@test "expands file patterns correctly and commits all changed files if dirty files are only in subdirectory" {
|
|
||||||
# Add more .txt files
|
|
||||||
mkdir "${FAKE_LOCAL_REPOSITORY}"/subdirectory/
|
|
||||||
touch "${FAKE_LOCAL_REPOSITORY}"/subdirectory/new-file-2.txt
|
|
||||||
mkdir "${FAKE_LOCAL_REPOSITORY}"/another-subdirectory/
|
|
||||||
touch "${FAKE_LOCAL_REPOSITORY}"/another-subdirectory/new-file-3.txt
|
|
||||||
|
|
||||||
INPUT_FILE_PATTERN="*.txt"
|
|
||||||
INPUT_DISABLE_GLOBBING=true
|
|
||||||
|
|
||||||
run git_auto_commit
|
|
||||||
|
|
||||||
assert_success
|
|
||||||
|
|
||||||
assert_line --partial "subdirectory/new-file-2.txt"
|
|
||||||
assert_line --partial "another-subdirectory/new-file-3.txt"
|
|
||||||
}
|
|
||||||
|
|
||||||
@test "detects if crlf in files change and does not create commit" {
|
|
||||||
# Set autocrlf to true
|
|
||||||
cd "${FAKE_LOCAL_REPOSITORY}"
|
|
||||||
git config core.autocrlf true
|
|
||||||
run git config --get-all core.autocrlf
|
|
||||||
assert_line "true"
|
|
||||||
|
|
||||||
# Add more .txt files
|
|
||||||
echo -ne "crlf test1\r\n" > "${FAKE_LOCAL_REPOSITORY}"/new-file-2.txt
|
|
||||||
echo -ne "crlf test1\n" > "${FAKE_LOCAL_REPOSITORY}"/new-file-3.txt
|
|
||||||
|
|
||||||
# Run git-auto-commit to add new files to repository
|
|
||||||
run git_auto_commit
|
|
||||||
|
|
||||||
# Change control characters in files
|
|
||||||
echo -ne "crlf test1\n" > "${FAKE_LOCAL_REPOSITORY}"/new-file-2.txt
|
|
||||||
echo -ne "crlf test1\r\n" > "${FAKE_LOCAL_REPOSITORY}"/new-file-3.txt
|
|
||||||
|
|
||||||
# Run git-auto-commit to commit the 2 changes files
|
|
||||||
run git_auto_commit
|
|
||||||
|
|
||||||
assert_success
|
|
||||||
|
|
||||||
refute_line --partial "2 files changed, 2 insertions(+), 2 deletions(-)"
|
|
||||||
assert_line --partial "warning: in the working copy of 'new-file-2.txt', LF will be replaced by CRLF the next time Git touches it"
|
|
||||||
|
|
||||||
assert_line --partial "Working tree clean. Nothing to commit."
|
|
||||||
assert_line --partial "new-file-2.txt"
|
|
||||||
assert_line --partial "new-file-3.txt"
|
|
||||||
|
|
||||||
# Changes are not detected
|
|
||||||
run cat_github_output
|
|
||||||
assert_line "changes_detected=false"
|
|
||||||
}
|
|
||||||
|
|
||||||
@test "detects if crlf in files change and creates commit if the actual content of the files change" {
|
|
||||||
# Set autocrlf to true
|
|
||||||
cd "${FAKE_LOCAL_REPOSITORY}"
|
|
||||||
git config core.autocrlf true
|
|
||||||
run git config --get-all core.autocrlf
|
|
||||||
assert_line "true"
|
|
||||||
|
|
||||||
# Add more .txt files
|
|
||||||
echo -ne "crlf test1\r\n" > "${FAKE_LOCAL_REPOSITORY}"/new-file-2.txt
|
|
||||||
echo -ne "crlf test1\n" > "${FAKE_LOCAL_REPOSITORY}"/new-file-3.txt
|
|
||||||
|
|
||||||
# Run git-auto-commit to add new files to repository
|
|
||||||
run git_auto_commit
|
|
||||||
|
|
||||||
# Change control characters in files
|
|
||||||
echo -ne "crlf test2\n" > "${FAKE_LOCAL_REPOSITORY}"/new-file-2.txt
|
|
||||||
echo -ne "crlf test2\r\n" > "${FAKE_LOCAL_REPOSITORY}"/new-file-3.txt
|
|
||||||
|
|
||||||
# Run git-auto-commit to commit the 2 changes files
|
|
||||||
run git_auto_commit
|
|
||||||
|
|
||||||
assert_success
|
|
||||||
|
|
||||||
assert_line --partial "2 files changed, 2 insertions(+), 2 deletions(-)"
|
|
||||||
assert_line --partial "warning: in the working copy of 'new-file-2.txt', LF will be replaced by CRLF the next time Git touches it"
|
|
||||||
|
|
||||||
assert_line --partial "new-file-2.txt"
|
|
||||||
assert_line --partial "new-file-3.txt"
|
|
||||||
|
|
||||||
# Changes are detected
|
|
||||||
run cat_github_output
|
|
||||||
assert_line "changes_detected=true"
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
@test "It uses old set-output syntax if GITHUB_OUTPUT environment is not available when changes are committed" {
|
|
||||||
unset GITHUB_OUTPUT
|
|
||||||
|
|
||||||
touch "${FAKE_LOCAL_REPOSITORY}"/new-file-{1,2,3}.txt
|
|
||||||
|
|
||||||
run git_auto_commit
|
|
||||||
|
|
||||||
assert_success
|
|
||||||
|
|
||||||
assert_line "INPUT_REPOSITORY value: ${INPUT_REPOSITORY}"
|
|
||||||
assert_line "INPUT_BRANCH value: ${FAKE_DEFAULT_BRANCH}"
|
|
||||||
assert_line "INPUT_FILE_PATTERN: ."
|
|
||||||
assert_line "INPUT_COMMIT_OPTIONS: "
|
|
||||||
assert_line "::debug::Apply commit options "
|
|
||||||
assert_line "INPUT_TAGGING_MESSAGE: "
|
|
||||||
assert_line "No tagging message supplied. No tag will be added."
|
|
||||||
assert_line "INPUT_PUSH_OPTIONS: "
|
|
||||||
assert_line "::debug::Apply push options "
|
|
||||||
assert_line "::debug::Push commit to remote branch ${FAKE_DEFAULT_BRANCH}"
|
|
||||||
|
|
||||||
assert_line "::set-output name=changes_detected::true"
|
|
||||||
assert_line -e "::set-output name=commit_hash::[0-9a-f]{40}$"
|
|
||||||
}
|
|
||||||
|
|
||||||
@test "It uses old set-output syntax if GITHUB_OUTPUT environment is not available when no changes have been detected" {
|
|
||||||
unset GITHUB_OUTPUT
|
|
||||||
|
|
||||||
run git_auto_commit
|
|
||||||
|
|
||||||
assert_success
|
|
||||||
|
|
||||||
assert_line "INPUT_REPOSITORY value: ${INPUT_REPOSITORY}"
|
|
||||||
assert_line "Working tree clean. Nothing to commit."
|
|
||||||
|
|
||||||
assert_line "::set-output name=changes_detected::false"
|
|
||||||
refute_line -e "::set-output name=commit_hash::[0-9a-f]{40}$"
|
|
||||||
}
|
|
||||||
|
|
||||||
@test "It fails hard if git is not available" {
|
|
||||||
INPUT_INTERNAL_GIT_BINARY=binary-does-not-exist
|
|
||||||
|
|
||||||
touch "${FAKE_LOCAL_REPOSITORY}"/new-file-{1,2,3}.txt
|
|
||||||
|
|
||||||
run git_auto_commit
|
|
||||||
|
|
||||||
assert_failure;
|
|
||||||
assert_line "::error::git-auto-commit could not find git binary. Please make sure git is available."
|
|
||||||
}
|
|
||||||
|
|
||||||
@test "It creates multi-line commit messages" {
|
|
||||||
touch "${FAKE_LOCAL_REPOSITORY}"/new-file-{1,2,3}.txt
|
|
||||||
|
|
||||||
COMMIT_MESSAGE=$(cat <<-END
|
|
||||||
this commit message
|
|
||||||
has multiple lines
|
|
||||||
END
|
|
||||||
)
|
|
||||||
|
|
||||||
INPUT_COMMIT_MESSAGE=$COMMIT_MESSAGE
|
|
||||||
|
|
||||||
run git_auto_commit
|
|
||||||
|
|
||||||
assert_success
|
|
||||||
|
|
||||||
# Assert last commit was signed off
|
|
||||||
run git log -n 1
|
|
||||||
assert_output --partial $COMMIT_MESSAGE
|
|
||||||
}
|
|
||||||
|
|
||||||
@test "It exits with error message if entrypoint.sh is being run not in a git repository" {
|
|
||||||
INPUT_REPOSITORY="${FAKE_FOLDER_WITHOUT_GIT_REPO}"
|
|
||||||
|
|
||||||
mkdir "${INPUT_REPOSITORY}"
|
|
||||||
|
|
||||||
run git_auto_commit
|
|
||||||
|
|
||||||
assert_failure;
|
|
||||||
assert_line "::error::git-status failed with:<fatal: not a git repository (or any of the parent directories): .git>"
|
|
||||||
}
|
|
||||||
|
|||||||
16
yarn.lock
16
yarn.lock
@@ -1,16 +0,0 @@
|
|||||||
# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
|
|
||||||
# yarn lockfile v1
|
|
||||||
|
|
||||||
|
|
||||||
bats-assert@ztombol/bats-assert:
|
|
||||||
version "0.3.0"
|
|
||||||
resolved "https://codeload.github.com/ztombol/bats-assert/tar.gz/9f88b4207da750093baabc4e3f41bf68f0dd3630"
|
|
||||||
|
|
||||||
bats-support@ztombol/bats-support:
|
|
||||||
version "0.3.0"
|
|
||||||
resolved "https://codeload.github.com/ztombol/bats-support/tar.gz/004e707638eedd62e0481e8cdc9223ad471f12ee"
|
|
||||||
|
|
||||||
bats@^1.11.0:
|
|
||||||
version "1.11.0"
|
|
||||||
resolved "https://registry.yarnpkg.com/bats/-/bats-1.11.0.tgz#40281f021f5befcc10da54ed5674aa5b181f4953"
|
|
||||||
integrity sha512-qiKdnS4ID3bJ1MaEOKuZe12R4w+t+psJF0ICj+UdkiHBBoObPMHv8xmD3w6F4a5qwUyZUHS+413lxENBNy8xcQ==
|
|
||||||
Reference in New Issue
Block a user