Skip to content

Update Validation docs and remove .lycheeignore - #98

Merged
alexander-yevsyukov merged 4 commits into
masterfrom
claude/validation-docs-links-c04c02
Nov 2, 2026
Merged

alexander-yevsyukov merged 4 commits into
masterfrom
claude/validation-docs-links-c04c02

Conversation

@alexander-yevsyukov

@alexander-yevsyukov alexander-yevsyukov commented Nov 2, 2026 •

Copy link
Copy Markdown
Contributor

SpineEventEngine/validation#341 fixed the broken links in the Validation docs, which this site imports as the github.com/SpineEventEngine/validation/docs Hugo module. This PR picks up those fixes and removes the temporary .lycheeignore that #96 added for them.

Fixes #97

Changes

  • Validation docs. The module moves from 6465029 to 2754355, the merge of validation#341 and the tip of validation's master. Both docs/go.mod and docs/_preview/go.mod pin it, so both change, with their go.sum files.
  • .lycheeignore is deleted. All 8 of its patterns now pass, so the file has nothing left:
    • the two validation/blob/master/.agents/… guidelines, embed-code-go/blob/master/EMBEDDING.md, and plugins.gradle.org/plugin/io.spine.validation (fixed by validation#341);
    • embed-code-go/tree/master/bin (already fixed on validation's master);
    • the three localhost links: 06-developers-guide/, developer/, and typical_custom_option.jpg (fixed by validation#341).
  • config and .agents/shared. ./config/pull moves config to 3a0d13a and .agents/shared to 551ad4f, the tips of their master branches. It updates only check-links.yml, which had no local edits:
    • Check Links also runs when .lycheeignore changes (config#826).
    • Site detection also finds a Hugo config in _preview/ (config#827). This repo still builds in docs/_preview.
    • Newer setup-node, cache, and release-downloader actions (config#825).
    • Lychee's report is added to the run summary.
  • Root Gradle project. settings.gradle.kts renames it from spine-docs to documentation, after the repository. Nothing in the build reads the name.
  • Example submodules. ./init-submodules leaves the docs/_code/examples submodules to this repository, so a fresh clone or worktree lacks them. checkSamples failed there, and embedCode embedded from empty directories, since git submodule update --remote skips submodules that were never initialized. A new checkOutExamples task, which both depend on, checks out each missing example at its pinned commit and leaves the others as they are. It runs docs/_script/check-out-examples, which also removes the .gradle directory Gradle writes into an empty included build, because that directory would block the clone.

Verification

  • hugo -e development in docs/_preview builds with no warnings.
  • Lychee 0.24.2 with lychee.toml, run as in CI but with no .lycheeignore: 791 unique links, 0 errors.
  • None of the 7 old URLs appears in the rendered site. The image now resolves to /docs/validation/user/05-custom-validation/typical_custom_option.jpg, which returns 200.
  • check-links.yml is byte-identical to config's template, and actionlint reports nothing.
  • ./gradlew :checkSamples, run with airport and hello missing (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. shellcheck reports nothing for the script.

After this merges, spine.io can update its documentation module and drop the same patterns from its own .lycheeignore, which SpineEventEngine/SpineEventEngine.github.io#564 added.

🤖 Generated with Claude Code

alexander-yevsyukov and others added 2 commits November 2, 2026 17:42
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>
Copilot AI balanced review requested due to automatic review settings November 2, 2026 17:55
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Nov 2, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-11-02T17:56:33.385866Z eb609e5 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 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 2754355aee88 in 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>
@alexander-yevsyukov alexander-yevsyukov self-assigned this Nov 2, 2026
@alexander-yevsyukov alexander-yevsyukov moved this to In Review in v2.0 Nov 2, 2026
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>
@alexander-yevsyukov
alexander-yevsyukov merged commit 3346b3f into master Nov 2, 2026
5 checks passed
@alexander-yevsyukov
alexander-yevsyukov deleted the claude/validation-docs-links-c04c02 branch November 2, 2026 18:18
@github-project-automation github-project-automation Bot moved this from In Review to ✅ Done in v2.0 Nov 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: ✅ Done

Development

Successfully merging this pull request may close these issues.

Remove the validation links from .lycheeignore once they are fixed

2 participants