Skip to content

Fix broken link check using workaround #279

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

Merged
merged 1 commit into from
Dec 1, 2024
Merged

Fix broken link check using workaround #279

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 4 additions & 2 deletions .github/workflows/check-links-in-documentation.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,11 @@ jobs:
startsWith(github.event.pull_request.title, 'Update dependency AxonFramework') &&
github.event.pull_request.user.type == 'Bot'
run: |
echo "Skipping link check on AxonFramework updates since the updated links tto the reports will only be active "
echo "Skipping link check on AxonFramework updates since the updated links to the reports will only be active "
echo "skip_link_check=true" >> $GITHUB_ENV

- name: Check links in top level documentation Markdown files
if: ${{ ! env.skip_link_check}}
run: npx --yes [email protected] --config=markdown-lint-check-config.json README.md COMMANDS.md GETTING_STARTED.md
run: npx --yes [email protected] --verbose --alive=200,202,206 --retry README.md COMMANDS.md GETTING_STARTED.md
# Temporarily, everything is done using command line options rather than with the config file, which doesn't seem to work.
# Maybe related to https://github.com/tcort/markdown-link-check/issues/379 ?
4 changes: 2 additions & 2 deletions GETTING_STARTED.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Use these optional command line options as needed:
./scripts/examples/analyzeAxonFramework.sh --report CSV
```

- Only explore the graph manually in the [browser](http://localhost:7474/browser). Skip all automated reports. Example:
- Only explore the graph manually in the browser (`http://localhost:7474/browser`). Skip all automated reports. Example:

```shell
./scripts/examples/analyzeAxonFramework.sh --explore
Expand Down Expand Up @@ -108,7 +108,7 @@ Use these optional command line options as needed:
./../../scripts/analysis/analyze.sh --explore
```

👉 Open your browser and login to your [local Neo4j Web UI](http://localhost:7474/browser) with "neo4j" as user and the initial password you've chosen.
👉 Open your browser and login to your local Neo4j Web UI (`http://localhost:7474/browser`) with "neo4j" as user and the initial password you've chosen.

## GitHub Actions

Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ The [Code Structure Analysis Pipeline](./.github/workflows/java-code-analysis.ym
👉 To get started from scratch see [GETTING_STARTED.md](./GETTING_STARTED.md).

- How can i explore the Graph manually?
👉 After analysis [start Neo4j](./COMMANDS.md#start-neo4j-graph-database) and open the [Neo4j Web UI](http://localhost:7474/browser).
👉 After analysis [start Neo4j](./COMMANDS.md#start-neo4j-graph-database) and open the Neo4j Web UI (`http://localhost:7474/browser`).

- How can i add a CSV report to the pipeline?
👉 Put your new cypher query into the [cypher](./cypher) directory or a suitable (new) sub directory.
Expand Down