Skip to content

feat: Add markdown link checker for PRs #572

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 4 commits into from
+34 −18
Closed

feat: Add markdown link checker for PRs #572

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0049dfc
add markdown link checker for PRs
pthmas Jun 18, 2025
a51bab9
Merge branch 'main' into pierrick/markdown_link_checker
pthmas Jun 27, 2025
6c59be2
Merge branch 'main' into pierrick/markdown_link_checker
pthmas Jul 8, 2025
aa80df9
fix dead markdown links
pthmas Jul 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions .github/workflows/markdowd_link_checker.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Check Markdown links

on:
# This workflow requires pull_request and won't work with pull_request_target
# due to github permissions
pull_request:
types:
- opened
- reopened
- synchronize
- closed

jobs:
markdown-link-check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: tcort/github-action-markdown-link-check@v1
Comment on lines +15 to +18

Check warning

Code scanning / CodeQL

Workflow does not contain permissions Medium

Actions job or workflow does not limit the permissions of the GITHUB_TOKEN. Consider setting an explicit permissions block, using the following as a minimal starting point: {contents: read}

Copilot Autofix

AI 21 days ago

To fix the issue, we need to add a permissions block to the workflow. Since the workflow only checks Markdown links, it requires minimal permissions. The contents: read permission is sufficient for this task, as it allows the workflow to read repository contents without granting unnecessary write access.

The permissions block should be added at the root level of the workflow file to apply to all jobs. This ensures that the GITHUB_TOKEN used by the workflow has restricted access.

Suggested changeset 1
.github/workflows/markdowd_link_checker.yml

Autofix patch

Autofix patch
Run the following command in your local git repository to apply this patch
cat << 'EOF' | git apply
diff --git a/.github/workflows/markdowd_link_checker.yml b/.github/workflows/markdowd_link_checker.yml
--- a/.github/workflows/markdowd_link_checker.yml
+++ b/.github/workflows/markdowd_link_checker.yml
@@ -2,2 +2,5 @@
 
+permissions:
+  contents: read
+
 on: 
EOF
@@ -2,2 +2,5 @@

permissions:
contents: read

on:
Copilot is powered by AI and may make mistakes. Always verify output.

Check warning

Code scanning / CodeQL

Unpinned tag for a non-immutable Action in workflow Medium

Unpinned 3rd party Action 'Check Markdown links' step
Uses Step
Loading
uses 'tcort/github-action-markdown-link-check' with ref 'v1', not a pinned commit hash
4 changes: 2 additions & 2 deletions guides/create-genesis.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This guide will walk you through the process of setting up a genesis for your ro

For this guide you need to have a chain directory where you have created and built your chain.

If you don't have a chain directory yet, you can initialize a simple ignite chain by following [this guide](./ignite-rollkit.md)
If you don't have a chain directory yet, you can initialize a simple ignite chain by following [this tutorial](/tutorials/gm-world.md)

:::tip
This guide will use the simple ignite chain created in linked guide. Make sure to update any relevant variables to match your chain.
Expand All @@ -27,7 +27,7 @@ STAKING_AMOUNT="1000000000stake"

## 2. Rebuild your chain

Ensure that `rollkit.toml` is present in the root of your rollup directory (if not, follow a [Guide](/guides/use-rollkit-cli) to set it up) and run the following command to (re)generate an entrypoint binary out of the code:
Ensure that `rollkit.toml` is present in the root of your rollup directory (if not, follow a [Guide](../gm-world.md) to set it up) and run the following command to (re)generate an entrypoint binary out of the code:

```sh
rollkit rebuild
Expand Down
25 changes: 12 additions & 13 deletions guides/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,22 +14,21 @@ your life easier when developing with Rollkit.

In this section, you'll find:

* [Create genesis for your rollup](/guides/create-genesis)
* [Restart your rollup](/guides/restart-rollup)
* [Reset your chain's state](/guides/reset-state)
* [Turn your CometBFT app into a Rollkit app](/guides/cometbft-to-rollkit)
* [Use Ignite to create a Rollkit app](/guides/ignite-rollkit)
* [Create genesis for your rollup](./create-genesis.md)
* [Restart your rollup](./restart-rollup.md)
* [Reset your chain's state](./reset-state.md)
* [Turn your CometBFT app into a Rollkit app](./cometbft-to-rollkit.md)
* EVM Rollups
* [EVM Based Sequencer Setup](/guides/evm-based)
* [EVM Single Sequencer Setup](/guides/evm-single-guide)
* [EVM Based Sequencer Setup](./evm-based.md)
* [EVM Single Sequencer Setup](./evm-single-guide.md)
* Configuration
* [Config Settings](/guides/config)
* [Config Settings](./config.md)
* Integrations
* [Test and deploy cosmwasm smart-contracts](/guides/cw-orch)
* [Add zkML to your EVM rollup](/guides/zkml)
* [Add an IBC connection to your rollup](/guides/ibc-connection)
* [Integrate Range with your rollup](/guides/rollkit-monitoring)
* [Use IBC token (TIA) as gas token in your rollup](/guides/use-tia-for-gas)
* [Test and deploy cosmwasm smart-contracts](./cw-orch.md)
* [Add zkML to your EVM rollup](./zkml.md)
* [Add an IBC connection to your rollup](./ibc-connection.md)
* [Integrate Range with your rollup](./rollkit-monitoring.md)
* [Use IBC token (TIA) as gas token in your rollup](./use-tia-for-gas.md)

## 💻 Support {#support}

Expand Down
5 changes: 2 additions & 3 deletions tutorials/sequencing/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

# Sequencing

Sequencing is the essential first step for handling your transactions. Think of it as an organizer that takes all incoming transactions, puts them in a clear order, and then groups them into batches. This process is vital for keeping everything consistent and making the rollup run. Rollkit uses a "Sequencing Interface" with key functions like submitting, retrieving, and verifying these transaction batches, ensuring smooth communication between the rollup and the sequencing mechanism, which often acts as a bridge to the underlying network.
Expand Down Expand Up @@ -27,5 +26,5 @@ An implementation of the sequencing interface mainly acts as a middleware that c

The sequencing implementations that are currently work in progress:
<!-- * [single-sequencer](single) -->
* [based-sequencer](based)
* [forced-inclusion-sequencer](forced-inclusion)
* [based-sequencer](based.md)
* [forced-inclusion-sequencer](forced-inclusion.md)