Repository navigation
ci: revert the fork-PR guards and drop the build checker - #933
Open
Daniel (dasanra) wants to merge 5 commits into
Open
Daniel (dasanra) wants to merge 5 commits into
Daniel (dasanra) wants to merge 5 commits into
Conversation
Fork PRs never upload anything to AWS, so they fail at the AWS credentials step and get no preview. Restore the original step conditions, record that rule at the top of deploy.yml, and remove the check-build script with its tests and fixtures.
The main sync now skips .txt and .md files, and the charset passes use sync instead of a recursive copy, so every file uploads once. The .xml pass is gone: sync already sets application/xml from the extension.
The link-check action only scans .md files by default, which skips almost every page. Run it once for .mdx and once for .md, and resolve absolute site links such as /sdk/onchain-tracking.mdx against pages/.
Absolute links whose path ends in an asset extension now resolve under public/ instead of pages/, so a future link such as /llms.txt is not reported dead. Page links keep resolving under pages/.
Without a condition the second step only runs after a green first step, so broken links in .md pages stayed hidden while any .mdx link was broken. The job still fails when either pass fails, so the weekly report issue is still created.
Contributor
Branch preview✅ Deploy successful! |
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.
What it solves
Resolves PLA-2307, part A (workflows and scripts). Cleans up the deploy and link-check workflows.
Changelog
deploy.yml: the five fork-PR conditions added in ci: fail the build on broken internal links and missing agent files #919 are reverted. A fork PR fails at the AWS credentials step and gets no preview, as before ci: fail the build on broken internal links and missing agent files #919.deploy.ymlanddeploy-release.yml: thepnpm check-buildsteps and the post-release--deployed https://docs.safe.globalcheck are removed. The checker blocked PR previews on one broken link anywhere on the site, and the production check ran after upload and invalidation with no rollback, coupling a docs release to api.safe.global.checkBuildOutput.ts,tests/checkBuildOutput.test.ts,tests/fixtures/site/and thecheck-buildscript are deleted.tests/generateAgentFiles.test.tsandtests/fixtures/agent-files/stay.s3_upload.sh: each file uploads once. The main sync excludes*.txtand*.md; two filtered syncs upload them withcharset=utf-8and--delete, so stale copies are still removed. The*.xmlpass is gone (sync picks an XML type from the extension). A comment states the charset is the only reason the filtered syncs exist. AWS CLI applies--exclude/--includeto the destination too, so the main sync's--deletenever touches.txt/.mdobjects.link-check.ymlandweekly-link-check.yml: thetcort/github-action-markdown-link-checkaction defaultsfile-extensionto.md, so both jobs have checked 22 of 358 pages since they were added. Each workflow now runs the action twice, for.mdxand.md.linkchecker-config.json:^/links resolve to{{BASEURL}}/pages/(the site uses absolute links such as/sdk/onchain-tracking.mdx), and^\{is ignored (JSX expressions such as<Image src={Var} />are not links).Link-check coverage
.mdx../depth).mdAll 13 will be fixed on the content branch (
pla-2307-content). Land that branch before or with this one, or the first weekly run opens a report issue.Regression checklist
<branch>--docs.review.5afe.devlink.AWS_STAGING_BUCKET_NAME) serves/llms.txtastext/plain; charset=utf-8and a.mdcopy astext/markdown; charset=utf-8;sitemap.xmlkeeps an XML type; no object is uploaded twice..html, extensionless key and.mdcopy from the bucket on the next deploy.workflow_dispatchthe weekly link check and read both steps' output.Checklist
safe-docspull request rules