Skip to content

Replace liche with lychee for link checking #83

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

Open
tamalsaha wants to merge 3 commits into
base: master
Choose a base branch
from
+8 −6
Open

Replace liche with lychee for link checking #83

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fc70b83
Replace liche with lychee for link checking
tamalsaha Jun 17, 2026
55a1b15
Fix lychee exclude regex and use --base-url
tamalsaha Jun 17, 2026
60072cc
Resolve relative links per-file and skip example URLs
tamalsaha Jun 17, 2026
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
10 changes: 6 additions & 4 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,11 @@ jobs:

- name: Install link checker
run: |
curl -fsSL -o liche https://github.com/appscodelabs/liche/releases/download/v0.1.0/liche-linux-amd64
chmod +x liche
sudo mv liche /usr/local/bin/liche
curl -fsSL -o lychee.tar.gz https://github.com/lycheeverse/lychee/releases/download/lychee-v0.24.2/lychee-x86_64-unknown-linux-gnu.tar.gz
tar -xzf lychee.tar.gz --strip-components=1
chmod +x lychee
sudo mv lychee /usr/local/bin/lychee
rm lychee.tar.gz

- name: Install codespan schema checker
run: |
Expand All @@ -34,7 +36,7 @@ jobs:

- name: Check links
run: |
liche -r docs -d $(pwd) -c 10 -p -h -l -x '^(.*/docs/{{<.*>}}/.*|.*github.com.*|.*api.slack.com.*|.*askapache.com.*|.*twitter.com.*|.*dev.mysql.com.*|.*linux.die.net.*|.*helm.sh.*|.*aws.amazon.com.*|.*kind.sigs.k8s.io.*|.*git.k8s.io.*)$'
lychee --root-dir $(pwd) --max-concurrency 10 --exclude '^(.*/docs/\{\{<.*>\}\}/.*|.*github.com.*|.*api.slack.com.*|.*askapache.com.*|.*twitter.com.*|.*dev.mysql.com.*|.*linux.die.net.*|.*helm.sh.*|.*aws.amazon.com.*|.*kind.sigs.k8s.io.*|.*git.k8s.io.*|.*localhost.*|.*kubedb.com.*)$' 'docs/**/*.md'

- name: Create Kubernetes cluster
id: kind
Expand Down
2 changes: 1 addition & 1 deletion docs/concepts/crds/backupconfiguration/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ Scheduler Spec specifies the configuration for the backup triggering CronJob for
| `completions` | Specifies the desired number of successfully finished pods the job should be run with. Setting to nil means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info [here](https://kubernetes.io/docs/concepts/workloads/controllers/job/#parallel-jobs) |
| `activeDeadlineSeconds` | Specifies the duration in seconds relative to the startTime that the job may be continuously active before the system tries to terminate it; value must be positive integer. If a Job is suspended (at creation or through an update), this timer will effectively be stopped and reset when the Job is resumed again. |
| `backoffLimit` | Specifies the number of retries before marking this job failed. Defaults to 6. |
| `template` | Describes the pod that will be created when executing a job. To know more about the fields in `template`, see [PodTemplate Spec]() |
| `template` | Describes the pod that will be created when executing a job. To know more about the fields in `template`, see PodTemplate Spec |
| `ttlSecondsAfterFinished` | `ttlSecondsAfterFinished` limits the lifetime of a Job that has finished execution (either Complete or Failed). If this field is set, `ttlSecondsAfterFinished` after the Job finishes, it is eligible to be automatically deleted. When the Job is being deleted, its lifecycle guarantees (e.g. finalizers) will be honored. If this field is unset, the Job won't be automatically deleted. If this field is set to zero, the Job becomes eligible to be deleted immediately after it finishes. This field is alpha-level and is only honored by servers that enable the TTLAfterFinished feature. |
| `completionMode` | CompletionMode specifies how Pod completions are tracked. More Information can be found [here](https://kubernetes.io/docs/concepts/workloads/controllers/job/#completion-mode) |
| `suspend` | Suspend specifies whether the Job controller should create Pods or not. If a Job is created with suspend set to true, no Pods are created by the Job controller. If a Job is suspended after creation (i.e. the flag goes from false to true), the Job controller will delete all active Pods associated with this Job. Users must design their workload to gracefully handle this. Suspending a Job will reset the StartTime field of the Job, effectively resetting the ActiveDeadlineSeconds timer too. This is an alpha field and requires the SuspendJob feature gate to be enabled; otherwise this field may not be set to true. Defaults to false. |
Expand Down
2 changes: 1 addition & 1 deletion docs/setup/upgrade/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ $ kubectl apply -f https://github.com/kubestash/installer/raw/{{< param "info.ve

#### 2. Upgrade Kubestash Operator

Now, upgrade the KubeStash helm chart using the following command. You can find the latest installation guide [here]().
Now, upgrade the KubeStash helm chart using the following command. You can find the latest installation guide here.

```bash
helm upgrade kubestash oci://ghcr.io/appscode-charts/kubestash \
Expand Down
Loading