Add new *_options to README
This commit is contained in:
		
							parent
							
								
									68f0d95687
								
							
						
					
					
						commit
						b9c536534c
					
				
							
								
								
									
										31
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										31
									
								
								README.md
									
									
									
									
									
								
							| @ -29,16 +29,16 @@ This is a more extended example with all possible options. | |||||||
| ```yaml | ```yaml | ||||||
| - uses: stefanzweifel/git-auto-commit-action@v4 | - uses: stefanzweifel/git-auto-commit-action@v4 | ||||||
|   with: |   with: | ||||||
|     # Optional but recommended |     # Optional, but recommended | ||||||
|     # Defaults to "Apply automatic changes" |     # Defaults to "Apply automatic changes" | ||||||
|     commit_message: Apply automatic changes |     commit_message: Automated Change | ||||||
| 
 | 
 | ||||||
|     # Optional branch name where commit should be pushed to |     # Optional branch name where commit should be pushed to. | ||||||
|     # Defaults to the current branch |     # Defaults to the current branch. | ||||||
|     branch: feature-123 |     branch: feature-123 | ||||||
| 
 | 
 | ||||||
|     # Optional options appended to `git-commit` |     # Optional. Used by `git-commit`. | ||||||
|     # See https://git-scm.com/docs/git-commit for a list of available options |     # See https://git-scm.com/docs/git-commit#_options | ||||||
|     commit_options: '--no-verify --signoff' |     commit_options: '--no-verify --signoff' | ||||||
| 
 | 
 | ||||||
|     # Optional glob pattern of files which should be added to the commit |     # Optional glob pattern of files which should be added to the commit | ||||||
| @ -61,17 +61,26 @@ This is a more extended example with all possible options. | |||||||
|     # Action will create and push a new tag to the remote repository and the defined branch |     # Action will create and push a new tag to the remote repository and the defined branch | ||||||
|     tagging_message: 'v1.0.0' |     tagging_message: 'v1.0.0' | ||||||
| 
 | 
 | ||||||
|     # Optional options appended to `git-push` |     # Optional. Used by `git-status` | ||||||
|     # See git-push documentation for details: https://git-scm.com/docs/git-push#_options |     # See https://git-scm.com/docs/git-status#_options | ||||||
|  |     status_options: '--untracked-files=no' | ||||||
|  | 
 | ||||||
|  |     # Optional. Used by `git-add` | ||||||
|  |     # See https://git-scm.com/docs/git-add#_options | ||||||
|  |     add_options: '-u' | ||||||
|  | 
 | ||||||
|  |     # Optional. Used by `git-push` | ||||||
|  |     # See https://git-scm.com/docs/git-push#_options | ||||||
|     push_options: '--force' |     push_options: '--force' | ||||||
|      |      | ||||||
|     # Optional: Disable dirty check and always try to create a commit and push |     # Optional. Disable dirty check and always try to create a commit and push | ||||||
|     skip_dirty_check: true     |     skip_dirty_check: true     | ||||||
|      |      | ||||||
|     # Optional: Skip internal call to `git fetch` |     # Optional. Skip internal call to `git fetch` | ||||||
|     skip_fetch: true     |     skip_fetch: true     | ||||||
|      |      | ||||||
|     # Optional: Prevents the shell from expanding filenames. Details: https://www.gnu.org/software/bash/manual/html_node/Filename-Expansion.html |     # Optional. Prevents the shell from expanding filenames.  | ||||||
|  |     # Details: https://www.gnu.org/software/bash/manual/html_node/Filename-Expansion.html | ||||||
|     disable_globbing: true |     disable_globbing: true | ||||||
| ``` | ``` | ||||||
| 
 | 
 | ||||||
|  | |||||||
		Loading…
	
		Reference in New Issue
	
	Block a user