Skip to content

Commit

Permalink
test: [#135] setup markdown lint to avoid 403 error
Browse files Browse the repository at this point in the history
GitHub returns a 403 response when we check links. You have to accept
compressed formats in the response.
  • Loading branch information
josecelano committed May 17, 2022
1 parent ad01072 commit 8965824
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 5 deletions.
3 changes: 2 additions & 1 deletion .cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@
"venv",
"vercel",
"vuepress",
"wscript"
"wscript",
"zstd"
]
}
10 changes: 10 additions & 0 deletions .markdown-link-check.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"httpHeaders": [
{
"urls": ["https://docs.github.com/"],
"headers": {
"Accept-Encoding": "zstd, br, gzip, deflate"
}
}
]
}
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

<!-- markdown-link-check-disable-next-line -->
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.
Expand Down Expand Up @@ -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.

<!-- markdown-link-check-disable-next-line -->
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`):
Expand Down Expand Up @@ -286,7 +284,7 @@ General conventions:
Conventions related to pull requests:

- We only allow rebase merges.
<!-- markdownlint-disable-next-line MD013 --><!-- markdown-link-check-disable-next-line -->
<!-- markdownlint-disable-next-line MD013 -->
- 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:
Expand Down

0 comments on commit 8965824

Please sign in to comment.