Skip to content

fix: exclude Astro docs/ from FOSSA license scanning#5499

Merged
leaanthony merged 2 commits into
wailsapp:masterfrom
taliesin-ai:translations/2026-05-23-711edb24
May 23, 2026
Merged

fix: exclude Astro docs/ from FOSSA license scanning#5499
leaanthony merged 2 commits into
wailsapp:masterfrom
taliesin-ai:translations/2026-05-23-711edb24

Conversation

@taliesin-ai

@taliesin-ai taliesin-ai commented May 23, 2026

Copy link
Copy Markdown
Collaborator

Summary

The docs/ Astro site was not in .fossa.yml's exclusion list, causing FOSSA License Compliance to fail on any PR that touches docs/.

Root cause: .fossa.yml correctly excludes website/ (Docusaurus), but the newer docs/ (Astro/Starlight) directory was not added when the docs site was migrated. FOSSA scans docs/package-lock.json and flags two groups of build-only packages:

Package License
@img/sharp-libvips-* (14 platform variants, from sharp) LGPL-3.0-or-later
@terrastruct/d2 (from astro-d2) MPL-2.0

Neither is distributed with the Wails Go module or @wailsio/runtime. Both are dev/build-time image and diagram tooling only.

Fix: two-line addition to .fossa.yml, mirroring the existing website/ exclusion.

Test plan

  • Verify FOSSA passes after merge on a PR that touches docs/

Summary by CodeRabbit

  • Chores
    • Updated license scanning configuration to expand coverage across additional directories.
    • Enhanced documentation within the scanning configuration to clarify the rationale behind dependency and license scanning for different site components.

Review Change Stack

The docs/ Astro site was not excluded from FOSSA npm scanning, causing
License Compliance to fail on PRs that touch docs/. The root packages
are build-time only and not distributed with the Wails module:

- sharp → @img/sharp-libvips-* (LGPL-3.0-or-later)
- astro-d2 → @terrastruct/d2 (MPL-2.0)

Extends the existing website/ exclusion pattern to also cover docs/.
@coderabbitai

coderabbitai Bot commented May 23, 2026

Copy link
Copy Markdown
Contributor

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 69786427-c2dc-49f1-a41b-95a65c622074

📥 Commits

Reviewing files that changed from the base of the PR and between dc3f120 and 34fd88f.

📒 Files selected for processing (1)
  • .fossa.yml

Walkthrough

FOSSA license scanning configuration is updated to exclude the docs directory as an npm target, extending the existing website exclusion. Explanatory comments document the rationale for excluding both Docusaurus and Astro-based documentation sites from license scanning.

Changes

FOSSA Configuration

Layer / File(s) Summary
FOSSA license scanning exclusions
.fossa.yml
Configuration extends targets.exclude to add docs npm package alongside existing website exclusion, with added inline comments explaining why both documentation sites are excluded from FOSSA license scanning.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • wailsapp/wails#5472: Earlier change that extended FOSSA license-scan exclusions for the docs site, providing foundational context for this additional exclusion refinement.

Suggested reviewers

  • leaanthony

Poem

🐰 A little config tweak so neat,
Docs excluded, license complete!
Two sites spared from the scanning light,
Fossa's list now set just right! 📋✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Description check ❓ Inconclusive The description is comprehensive and well-structured, covering the problem, root cause, specific packages flagged, and the fix. However, it does not follow the repository's required PR template with its expected sections and checklists. Consider using the repository's PR description template: fill in the Description, Type of change, How Has This Been Tested, and Checklist sections to ensure consistency with project standards.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically summarizes the main change: excluding the Astro docs/ directory from FOSSA license scanning.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@leaanthony leaanthony merged commit 1da4380 into wailsapp:master May 23, 2026
28 of 29 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants