Skip to content

Commit

Permalink
chore(ci): restrict what and when to check with lychee to avoid rate …
Browse files Browse the repository at this point in the history
…limiting (#197)
  • Loading branch information
Zebradil authored Dec 29, 2023
1 parent ce25793 commit 28c7f42
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 5 deletions.
7 changes: 5 additions & 2 deletions .github/workflows/check-links-quickly.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,11 @@ name: Check Links Quickly
- dev
paths:
- .github/workflows/check-links-quickly.yaml
- "**.md"
- docs/**.md
pull_request:
paths:
- .github/workflows/check-links-quickly.yaml
- docs/**.md

jobs:
linkChecker:
Expand All @@ -29,7 +32,7 @@ jobs:
uses: lycheeverse/[email protected]
with:
fail: true
args: "--base . --verbose --no-progress --cache --max-cache-age 3d './**/*.md'"
args: "--base . --verbose --no-progress --cache --max-cache-age 3d 'docs/**/*.md'"

- name: Save lychee cache
uses: actions/cache/save@v3
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/check-links.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ jobs:
- name: Run lychee
uses: lycheeverse/[email protected]
with:
args: "--base . --verbose --no-progress --cache --max-cache-age 3d './**/*.md'"
args: "--base . --verbose --no-progress --cache --max-cache-age 3d 'docs/**/*.md'"

- name: Save lychee cache
uses: actions/cache/save@v3
Expand Down
4 changes: 2 additions & 2 deletions README.md → docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,11 +101,11 @@ Myks has two main stages of operation: `sync` and `render`.
The `sync` stage downloads and caches upstream sources, while the `render` stage renders the manifests.
The `all` command runs both stages in sequence for convenience.
All of the commands support accept two optional arguments: environments and applications to process.
When no arguments are provided, myks will use the [Smart Mode](docs/SMARTMODE.md) to detect what to process.
When no arguments are provided, myks will use the [Smart Mode](SMARTMODE.md) to detect what to process.

### Examples

A few example setups are available in the [examples](examples) directory.
A few example setups are available in the [examples](/examples) directory.

And here are some real-world examples:

Expand Down

0 comments on commit 28c7f42

Please sign in to comment.