Add CI checks and CD deploy pipeline#12
Open
charitra-prem wants to merge 1 commit into
Open
Conversation
CI (.github/workflows/docs-checks.yml) runs on every PR to main: - Mintlify build + broken-links check (also catches MDX parse and docs.json schema errors since mint refuses to start on either). - cspell against every .mdx file, configured for en + en-GB with a custom allowlist for service names, Fluso terminology, and a few proper nouns that show up in the existing docs. CD (.github/workflows/deploy.yml) fires on push to main and on manual workflow_dispatch. Hits Mintlify's redeploy API endpoint with a Bearer API key. Concurrency-guarded so two pushes don't race. Refuses to run if the required repo secrets aren't set, so the failure mode is obvious rather than silently no-op.
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 this adds
Two GitHub Actions workflows and a cspell config. No production behavior changes until you set the secrets at the bottom.
CI — `.github/workflows/docs-checks.yml`
Fires on every pull request to `main`. Two parallel jobs:
Both jobs are advisory today — there's no branch protection requiring them. PR will go red on failure but won't be blocked. Flip on required status checks in repo Settings → Branches → Branch protection rules when you trust the noise level.
CD — `.github/workflows/deploy.yml`
Fires on push to `main` and on manual `workflow_dispatch`. Hits Mintlify's redeploy API:
```
POST https://api.mintlify.com/v1/project/update/\${MINTLIFY_PROJECT_ID}
Authorization: Bearer ${MINTLIFY_API_KEY}
```
What you need to do to turn deploy on
If the API endpoint or auth shape differs from what Mintlify wants today, the workflow will fail loudly on the first run and the response body in the log will tell us what to adjust.
🤖 Generated with Claude Code