fix: repair broken README links and correct release-artifact claims - #7
Closed
bah-dams wants to merge 1 commit into
Closed
fix: repair broken README links and correct release-artifact claims#7bah-dams wants to merge 1 commit into
bah-dams wants to merge 1 commit into
Conversation
The README linked docs/foundry/releases/release-channels.md and docs/foundry/releases/adopting.md, neither of which is published, so both 404'd for anyone browsing this repository. Rather than drop the adopter guidance along with the link, inline a "Consuming these packages" section covering the release assets, downloading them, and pinning against your own index. The release-model bullet also misdescribed what a tag produces: releases attach a wheel, an sdist, and a CycloneDX SBOM. Syft and Grype run on pull requests as advisory CI output and are not release assets. docs/foundry/index.md linked a site-absolute /docs/... path, which resolves only on the rendered docs site and 404s when the file is browsed here. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
| See [docs/foundry/releases/release-channels.md](docs/foundry/releases/release-channels.md) | ||
| for internal RC/dev publishing and [docs/foundry/releases/adopting.md](docs/foundry/releases/adopting.md) | ||
| for the adopter flow. | ||
| Syft and Grype also run on pull requests, but their output is advisory CI |
Contributor
There was a problem hiding this comment.
is Syft used? foundry-agent-packages/.github/workflows/release.yml shows cyclonedx-py being used
| See [docs/foundry/releases/release-channels.md](docs/foundry/releases/release-channels.md) | ||
| for internal RC/dev publishing and [docs/foundry/releases/adopting.md](docs/foundry/releases/adopting.md) | ||
| for the adopter flow. | ||
| Syft and Grype also run on pull requests, but their output is advisory CI |
Contributor
There was a problem hiding this comment.
Grype runs on the release workflow not on pull requests
Author
|
I'm going to close this PR in favor of an internal fix. |
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
2 participants
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.
Why
The README's "Release model" section linked
docs/foundry/releases/release-channels.mdand
docs/foundry/releases/adopting.md. Neither path exists in this repository, soboth links 404'd for anyone browsing it (FOUNDRY-948).
docs/foundry/index.mdhad a second, separate failure: a site-absolute/docs/guides/spec-driven-extensionslink, which resolves only on the rendereddocs site and 404s when the file is read here.
What changed
docs/foundry/releases/. Rather thanremove the adopter guidance along with the link, this inlines a
Consuming these packages section: the release assets,
gh release download,and the
[[tool.uv.index]]/[tool.uv.sources]snippet. The documentationtable's "Adopting" row now points at that section.
wheel, an sdist, and a CycloneDX SBOM per changed package. Syft and Grype
run on pull requests as advisory CI output and are not release assets, so
the previous "Syft SBOM + Grype scan … attached to the GitHub Release" bullet
would have sent adopters looking for assets that are never published.
AGENTS.md#spec-driven-changes-via-openspec-opt-in, which resolves here.Verification
Every relative link in the repository was resolved against the actual file list:
88 markdown files, 0 unresolvable targets, 0 site-absolute paths.
Note on scope
This is a direct patch, not a re-export. A companion change in the internal
repository moves the two unpublished pages so they conform to the export rules,
which will let
adopting.mdpublish on a future export and converge this READMEwith it.
🤖 Generated with Claude Code