Use new Markdown Alerts in README
This commit is contained in:
		
							parent
							
								
									e8f94e4dd2
								
							
						
					
					
						commit
						8036286d37
					
				
							
								
								
									
										12
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										12
									
								
								README.md
									
									
									
									
									
								
							| @ -47,7 +47,7 @@ jobs: | ||||
|       - uses: stefanzweifel/git-auto-commit-action@v5 | ||||
| ``` | ||||
| 
 | ||||
| > **Note**   | ||||
| > [!NOTE] | ||||
| > The Action has to be used in a Job that runs on a UNIX system (e.g. `ubuntu-latest`). | ||||
| 
 | ||||
| The following is an extended example with all available options. | ||||
| @ -282,13 +282,13 @@ See [this announcement from GitHub](https://github.blog/2020-08-03-github-action | ||||
| <details> | ||||
| <summary>Expand to learn more</summary> | ||||
| 
 | ||||
| > **Note**    | ||||
| > [!NOTE]  | ||||
| > This Action technically works with forks. However, please note that the combination of triggers and their options can cause issues. Please read [the documentation](https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows) on which triggers GitHub Actions support.\ | ||||
| > Ensure your contributors enable "Allow edits by maintainers" when opening a pull request. ([Learn more](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork)) \ | ||||
| > \ | ||||
| > **If you use this Action in combination with a linter/fixer, it's easier if you run the Action on `push` on your `main`-branch.** | ||||
| 
 | ||||
| > **Warning**    | ||||
| > [!WARNING]  | ||||
| > Due to limitations of GitHub, this Action currently can't push commits to a base repository, if the fork _lives_ under an organisation. See [github/community#6634](https://github.com/orgs/community/discussions/5634) and [this comment](https://github.com/stefanzweifel/git-auto-commit-action/issues/211#issuecomment-1428849944) for details. | ||||
| 
 | ||||
| By default, this Action will not run on Pull Requests which have been opened by forks. (This is a limitation by GitHub, not by us.)    | ||||
| @ -338,7 +338,7 @@ jobs: | ||||
| 
 | ||||
| ### Workflow should run in **forked** repository | ||||
| 
 | ||||
| > **Warning**    | ||||
| > [!WARNING]  | ||||
| > **This part of the documentation is outdated.**    | ||||
| > We were not able to configure a GitHub Action workflow for forks, that the workflow would run in the fork / head repository. | ||||
| > Please let us know in the [discussions](https://github.com/stefanzweifel/git-auto-commit-action/discussions)-area, if and how you achieved that. | ||||
| @ -397,7 +397,7 @@ For more information about running Actions on forks, see [this announcement from | ||||
| 
 | ||||
| If you would like to use this Action to create a commit using [`--amend`](https://git-scm.com/docs/git-commit#Documentation/git-commit.txt---amend) and [`--no-edit`](https://git-scm.com/docs/git-commit#Documentation/git-commit.txt---no-edit) you need to make some adjustments. | ||||
| 
 | ||||
| > **Warning**    | ||||
| > [!CAUTION]  | ||||
| > You should understand the implications of rewriting history if you amend a commit that has already been published. [See rebasing](https://git-scm.com/docs/git-rebase#_recovering_from_upstream_rebase). | ||||
| 
 | ||||
| First, you need to extract the previous commit message by using `git log -1 --pretty=%s`. | ||||
| @ -458,7 +458,7 @@ store the token as a secret in your repository and pass the new token to the [`a | ||||
| ``` | ||||
| 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). | ||||
| 
 | ||||
| > **Note** | ||||
| > [!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. | ||||
| 
 | ||||
| 
 | ||||
|  | ||||
		Loading…
	
		Reference in New Issue
	
	Block a user