Repository navigation
Update Validation docs and remove .lycheeignore - #98
Merged
Merged
Conversation
Move `github.com/SpineEventEngine/validation/docs` to `2754355a`, the merge of SpineEventEngine/validation#341, which fixes the broken links in the Validation docs. Lychee passes over the built site without the patterns that `.lycheeignore` held, so the file goes. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Run `./config/pull`, which moves `config` to `3a0d13a` and `.agents/shared` to `551ad4f`, the tips of their `master` branches. The `.agents/shared` pin is force-added, because `.gitmodules` sets `ignore = all` for it. The pull updates only `check-links.yml`, which had no local edits: - Check Links also runs when `.lycheeignore` changes. - Site detection also finds a Hugo config in `_preview/`. Here it still picks `docs/_preview` as the work directory. - Newer `setup-node`, `cache`, and `release-downloader` actions. - Lychee's report is added to the run summary. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
There was a problem hiding this comment.
🟢 Approved
No active review issues are reported for the documentation and link-check workflow updates.
No open issues 🎉
What changed in this PR
Updates the imported Validation documentation to include upstream link fixes and removes the temporary exclusions tracked by #97.
Changes:
- Pins Validation docs to
2754355aee88in both the documentation module and preview, with matching checksums. - Deletes
.lycheeignore, removing all eight temporary exclusion patterns. - Syncs the link-check workflow with config updates for preview-site detection, action versions, ignore-file triggers, and run-summary reporting.
| File | Description |
|---|---|
docs/go.sum |
Adds checksums for the updated Validation docs module. |
docs/go.mod |
Pins the documentation module to the fixed Validation revision. |
docs/_preview/go.sum |
Adds matching Validation checksums for the preview. |
docs/_preview/go.mod |
Pins the preview to the same Validation revision. |
.lycheeignore |
Removes temporary exclusions for the fixed links. |
.github/workflows/check-links.yml |
Syncs site detection, actions, triggers, and link-report publishing. |
Review effort: Balanced
The name now matches the repository. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The code samples come from the `docs/_code/examples` submodules, which `./init-submodules` leaves to this repository and a fresh clone or worktree lacks. `checkSamples` failed there, and `embedCode` embedded from empty directories, because `git submodule update --remote` skips submodules that were never initialized. The new `checkOutExamples` task, which both tasks depend on, checks out each missing example at its pinned commit. Examples that are already checked out stay as they are. Gradle writes a `.gradle` directory into an empty included build, which blocks the clone, so the script removes it when it is all there is. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
SpineEventEngine/validation#341 fixed the broken links in the Validation docs, which this site imports as the
github.com/SpineEventEngine/validation/docsHugo module. This PR picks up those fixes and removes the temporary.lycheeignorethat #96 added for them.Fixes #97
Changes
6465029to2754355, the merge of validation#341 and the tip of validation'smaster. Bothdocs/go.modanddocs/_preview/go.modpin it, so both change, with theirgo.sumfiles..lycheeignoreis deleted. All 8 of its patterns now pass, so the file has nothing left:validation/blob/master/.agents/…guidelines,embed-code-go/blob/master/EMBEDDING.md, andplugins.gradle.org/plugin/io.spine.validation(fixed by validation#341);embed-code-go/tree/master/bin(already fixed on validation'smaster);localhostlinks:06-developers-guide/,developer/, andtypical_custom_option.jpg(fixed by validation#341).configand.agents/shared../config/pullmovesconfigto3a0d13aand.agents/sharedto551ad4f, the tips of theirmasterbranches. It updates onlycheck-links.yml, which had no local edits:.lycheeignorechanges (config#826)._preview/(config#827). This repo still builds indocs/_preview.setup-node,cache, andrelease-downloaderactions (config#825).settings.gradle.ktsrenames it fromspine-docstodocumentation, after the repository. Nothing in the build reads the name../init-submodulesleaves thedocs/_code/examplessubmodules to this repository, so a fresh clone or worktree lacks them.checkSamplesfailed there, andembedCodeembedded from empty directories, sincegit submodule update --remoteskips submodules that were never initialized. A newcheckOutExamplestask, which both depend on, checks out each missing example at its pinned commit and leaves the others as they are. It runsdocs/_script/check-out-examples, which also removes the.gradledirectory Gradle writes into an empty included build, because that directory would block the clone.Verification
hugo -e developmentindocs/_previewbuilds with no warnings.lychee.toml, run as in CI but with no.lycheeignore: 791 unique links, 0 errors./docs/validation/user/05-custom-validation/typical_custom_option.jpg, which returns 200.check-links.ymlis byte-identical to config's template, andactionlintreports nothing../gradlew :checkSamples, run withairportandhellomissing (the state a new worktree starts in), checks both out at their pins and passes. A second run changes nothing, and an example on another commit keeps that commit.shellcheckreports nothing for the script.After this merges, spine.io can update its
documentationmodule and drop the same patterns from its own.lycheeignore, which SpineEventEngine/SpineEventEngine.github.io#564 added.🤖 Generated with Claude Code