diff --git a/.cspell.json b/.cspell.json index cbd0f8e4..2e9121ea 100644 --- a/.cspell.json +++ b/.cspell.json @@ -65,6 +65,7 @@ "venv", "vercel", "vuepress", - "wscript" + "wscript", + "zstd" ] } diff --git a/.markdown-link-check.json b/.markdown-link-check.json new file mode 100644 index 00000000..15fb56f8 --- /dev/null +++ b/.markdown-link-check.json @@ -0,0 +1,10 @@ +{ + "httpHeaders": [ + { + "urls": ["https://docs.github.com/"], + "headers": { + "Accept-Encoding": "zstd, br, gzip, deflate" + } + } + ] +} diff --git a/README.md b/README.md index 1da831b7..8f064a82 100644 --- a/README.md +++ b/README.md @@ -35,11 +35,10 @@ You can use it if: - You have workflows running in parallel. - The workflows are going to create new commits in a branch and those commits are going to be merged into another branch. -- And you wan to coordinate them to avoid concurrency problems like duplicate commits or commits in the wrong order. +- And you want to coordinate them to avoid concurrency problems like duplicate commits or commits in the wrong order. ### Why to use it - There are other alternatives like [GitHub concurrency groups](https://docs.github.com/en/actions/using-jobs/using-concurrency), but: - In some cases, it could be convenient not to couple your application to the GitHub infrastructure. @@ -68,7 +67,6 @@ The problem this action was trying to solve initially was updating a submodule i It requires to enable only fast forward merges. - It works on Linux, macOS and Windows [virtual environments](https://help.github.com/en/articles/virtual-environments-for-github-actions#supported-virtual-environments-and-hardware-resources). The action has 3 different commands (specified by the input `action`): @@ -286,7 +284,7 @@ General conventions: Conventions related to pull requests: - We only allow rebase merges. - + - Pull request merges must be done using the console because [GitHub Rebase](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges) does not work exactly like [Git Rebase](https://git-scm.com/docs/git-rebase) and commits are re-created not signed. Conventions related to releases: