From ae6efc59f11afc269fef8b958d6187e689e0c71e Mon Sep 17 00:00:00 2001 From: German Lashevich Date: Fri, 29 Dec 2023 16:23:47 +0100 Subject: [PATCH 1/2] chore(ci): restrict what and when to check with lychee to avoid rate limiting --- .github/workflows/check-links-quickly.yaml | 7 +++++-- .github/workflows/check-links.yaml | 2 +- README.md => docs/README.md | 0 3 files changed, 6 insertions(+), 3 deletions(-) rename README.md => docs/README.md (100%) diff --git a/.github/workflows/check-links-quickly.yaml b/.github/workflows/check-links-quickly.yaml index 3702fc29..cae7d629 100644 --- a/.github/workflows/check-links-quickly.yaml +++ b/.github/workflows/check-links-quickly.yaml @@ -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: @@ -29,7 +32,7 @@ jobs: uses: lycheeverse/lychee-action@v1.8.0 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 diff --git a/.github/workflows/check-links.yaml b/.github/workflows/check-links.yaml index 7db71929..379398c7 100644 --- a/.github/workflows/check-links.yaml +++ b/.github/workflows/check-links.yaml @@ -26,7 +26,7 @@ jobs: - name: Run lychee uses: lycheeverse/lychee-action@v1.8.0 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 diff --git a/README.md b/docs/README.md similarity index 100% rename from README.md rename to docs/README.md From a866cb94d2c555c7acf997d4e18b95a35e498b0a Mon Sep 17 00:00:00 2001 From: German Lashevich Date: Fri, 29 Dec 2023 16:27:07 +0100 Subject: [PATCH 2/2] fix links --- docs/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/README.md b/docs/README.md index 0d0a95a0..23769d55 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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: