You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+21-21Lines changed: 21 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ Adding git-auto-commit to your Workflow only takes a couple lines of code.
16
16
2. Add the following step at the end of your job, after other steps that might add or change files.
17
17
18
18
```yaml
19
-
- uses: step-security/git-auto-commit-action@v5
19
+
- uses: step-security/git-auto-commit-action@v7
20
20
```
21
21
22
22
Your Workflow should look similar to this example.
@@ -36,15 +36,15 @@ jobs:
36
36
contents: write
37
37
38
38
steps:
39
-
- uses: actions/checkout@v4
39
+
- uses: actions/checkout@v5
40
40
with:
41
41
ref: ${{ github.head_ref }}
42
42
43
43
# Other steps that change files in the repository go here
44
44
# …
45
45
46
46
# Commit all changed files back to the repository
47
-
- uses: step-security/git-auto-commit-action@v5
47
+
- uses: step-security/git-auto-commit-action@v7
48
48
```
49
49
50
50
> [!NOTE]
@@ -53,7 +53,7 @@ jobs:
53
53
The following is an extended example with all available options.
54
54
55
55
```yaml
56
-
- uses: step-security/git-auto-commit-action@v5
56
+
- uses: step-security/git-auto-commit-action@v7
57
57
with:
58
58
# Optional. Commit message for the created commit.
59
59
# Defaults to "Apply automatic changes"
@@ -85,11 +85,11 @@ The following is an extended example with all available options.
85
85
86
86
# Optional. Tag name to be created in the local repository and
87
87
# pushed to the remote repository on the defined branch.
88
-
# If only one of `tag` or `tagging_message` is provided, the value of the provided field will be used for both tag name and message.
89
-
tag: 'v1.0.0'
88
+
# If only one of `tag_name` or `tagging_message` is provided, the value of the provided field will be used for both tag name and message.
89
+
tag_name: 'v1.0.0'
90
90
91
91
# Optional. Message to annotate the created tag with.
92
-
# If only one of `tag` or `tagging_message` is provided, the value of the provided field will be used for both tag name and message.
92
+
# If only one of `tag_name` or `tagging_message` is provided, the value of the provided field will be used for both tag name and message.
93
93
tagging_message: 'Codename "Sunshine"'
94
94
95
95
# Optional. Option used by `git-status` to determine if the repository is
@@ -152,14 +152,14 @@ jobs:
152
152
contents: write
153
153
154
154
steps:
155
-
- uses: actions/checkout@v4
155
+
- uses: actions/checkout@v5
156
156
with:
157
157
ref: ${{ github.head_ref }}
158
158
159
159
- name: Run php-cs-fixer
160
160
uses: docker://oskarstark/php-cs-fixer-ga
161
161
162
-
- uses: step-security/git-auto-commit-action@v5
162
+
- uses: step-security/git-auto-commit-action@v7
163
163
with:
164
164
commit_message: Apply php-cs-fixer changes
165
165
```
@@ -181,7 +181,7 @@ You can use these outputs to trigger other Actions in your Workflow run based on
181
181
### Example
182
182
183
183
```yaml
184
-
- uses: step-security/git-auto-commit-action@v5
184
+
- uses: step-security/git-auto-commit-action@v7
185
185
id: auto-commit-action #mandatory for the output to show up in ${{ steps }}
186
186
with:
187
187
commit_message: Apply php-cs-fixer changes
@@ -217,7 +217,7 @@ You must use `action/checkout@v2` or later versions to check out the repository.
217
217
In non-`push` events, such as `pull_request`, make sure to specify the `ref` to check out:
218
218
219
219
```yaml
220
-
- uses: actions/checkout@v4
220
+
- uses: actions/checkout@v5
221
221
with:
222
222
ref: ${{ github.head_ref }}
223
223
```
@@ -235,7 +235,7 @@ You can change this by creating a new [Personal Access Token (PAT)](https://gith
235
235
storing the token as a secret in your repository and then passing the new token to the [`actions/checkout`](https://github.com/actions/checkout#usage) Action step.
236
236
237
237
```yaml
238
-
- uses: actions/checkout@v4
238
+
- uses: actions/checkout@v5
239
239
with:
240
240
token: ${{ secrets.PAT }}
241
241
```
@@ -281,7 +281,7 @@ The example below can be used as a starting point to generate a multiline commit
281
281
# Quick and dirty step to get rid of the temporary file holding the commit message
# Checkout the fork/head-repository and push changes to the fork.
371
371
# If you skip this, the base repository will be checked out and changes
@@ -379,7 +379,7 @@ jobs:
379
379
- name: Run php-cs-fixer
380
380
uses: docker://oskarstark/php-cs-fixer-ga
381
381
382
-
- uses: step-security/git-auto-commit-action@v5
382
+
- uses: step-security/git-auto-commit-action@v7
383
383
```
384
384
385
385
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/).
@@ -414,7 +414,7 @@ The steps in your workflow might look like this:
@@ -454,7 +454,7 @@ If you create a personal access token (classic), apply the `repo` and `workflow`
454
454
If you create a fine-grained personal access token, apply the `Contents`-permissions.
455
455
456
456
```yaml
457
-
- uses: actions/checkout@v4
457
+
- uses: actions/checkout@v5
458
458
with:
459
459
# 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".
460
460
token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
@@ -468,7 +468,7 @@ You can learn more about Personal Access Token in the [GitHub documentation](htt
468
468
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.
469
469
470
470
```yaml
471
-
- uses: step-security/git-auto-commit-action@v5
471
+
- uses: step-security/git-auto-commit-action@v7
472
472
with:
473
473
commit_message: Apply php-cs-fixer changes
474
474
push_options: --force
@@ -497,7 +497,7 @@ This is due to the fact, that the `*.md`-glob is expanded before sending it to `
497
497
To fix this add `disable_globbing: true` to your Workflow.
498
498
499
499
```yaml
500
-
- uses: step-security/git-auto-commit-action@v5
500
+
- uses: step-security/git-auto-commit-action@v7
501
501
with:
502
502
file_pattern: '*.md'
503
503
disable_globbing: true
@@ -524,7 +524,7 @@ yarn test
524
524
525
525
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/step-security/git-auto-commit-action/tags).
526
526
527
-
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 `step-security/git-auto-commit-action@v5` to always use the latest release of the current major version.
527
+
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 `step-security/git-auto-commit-action@v7` to always use the latest release of the current major version.
528
528
(More information about this [here](https://help.github.com/en/actions/building-actions/about-actions#versioning-your-action).)
0 commit comments