-
Notifications
You must be signed in to change notification settings - Fork 207
Add CI Checks Page, add to mint.json #501
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 2 commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
52600a0
add ci checks page, add to mint.json
IHSten 2100905
wording, messaging
IHSten 8a459a1
add note to warning about paid plans
IHSten 84055b0
empty trigger to trigger source checks
IHSten 487214a
test commit since we need an effective change
IHSten 6368f37
remove test commit
IHSten 2fb4c1f
Merge branch 'main' into ian/add-ci-checks-page
IHSten bb5c400
test commit to trigger Vale
IHSten aef0a48
drop test changes
IHSten c8403ee
add CI checks page to docs.json
IHSten 3d7c7ab
small typo
IHSten File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,114 @@ | ||
--- | ||
title: CI Checks | ||
description: "Use Mintlify's CI tools to lint your docs" | ||
icon: 'circle-check' | ||
--- | ||
|
||
<Warning> | ||
This feature is only available for customers using GitHub. If you'd like it enabled for other platforms, please provide [feedback](https://feedback.mintlify.com/roadmap). | ||
</Warning> | ||
|
||
Mintlify is capable of using its installed Github App to lint your docs for errors, and give you warnings before you deploy. | ||
|
||
## Installation | ||
|
||
To begin, will need to have followed the steps on the [GitHub](/settings/github) page. | ||
|
||
For GitHub Apps, you can choose to only give permissions to a single repository. | ||
We highly recommend you do so as we only need access to the repository where | ||
your docs are hosted. | ||
|
||
## Configuration | ||
|
||
You can configure the CI checks enabled for a deployment on the Mintlify dashboard by navigating to the 'Add-Ons' tab. There you can enable or disable the checks you'd like to run. | ||
|
||
When enabling checks, you can choose to run them at a `Warning` or `Blocking` level. | ||
|
||
<Note> | ||
|
||
|
||
A `Blocking` level check will provide a failure status if not passed, or changes are suggested.<br/> | ||
|
||
A `Warning` level check will never provide a failure status, even if there is an error or suggestions. | ||
|
||
</Note> | ||
|
||
## When Do They Run? | ||
|
||
CI checks are configured to run on commits to your configured deployment branch, or on pull requests against that branch. | ||
|
||
## Available CI Checks | ||
|
||
### Broken Links | ||
|
||
Similarly to how the [CLI link checker](/settings/broken-links#broken-links) works on your local machine, we will automatically check your docs for broken links. | ||
To see the results of this check, you can visit GitHub's check results page for a specific commit. | ||
|
||
### Vale | ||
|
||
[Vale](https://vale.sh/) is an open-source rule-based prose linter which supports a range of document types, including Markdown and MDX. | ||
|
||
Mintlify supports automatically running Vale in a CI check, and displaying the results as a check status. | ||
|
||
#### Configuration | ||
If you have a `.vale.ini` file in the root the content directory for your deployment, we will automatically use that configuration file. | ||
We will also automatically use any configuration files in your specified `stylesPath`. | ||
|
||
<Tip>Don't have a Vale config or not sure where to get started? Don't worry, Mintlify has a default configuration that will automatically be used if one is not provided.</Tip> | ||
|
||
<Warning> | ||
Please note that for security reasons, we are unable to support any absolute `stylesPath`, or `stylesPath` which include `..` values. Please use relative paths and include the `stylesPath` in your repository. | ||
</Warning> | ||
|
||
#### Packages | ||
Vale supports a range of [packages](https://vale.sh/docs/keys/packages), which can be used to check for spelling and style errors. | ||
Any packages you include in your repository under the correct `stylesPath` will be automatically installed and used in your Vale configuration. | ||
|
||
For packages not included in your repository, you may specify any packages from the [Vale package registry](https://vale.sh/explorer), and they will automatically be downloaded and used in your Vale configuration. | ||
|
||
<Warning> | ||
Please note that for security reasons, we are unable to support automatically downloading packages that are not from the [Vale package registry](https://vale.sh/explorer). | ||
</Warning> | ||
|
||
#### Vale with MDX | ||
Vale does not natively support MDX, but Vale's author has provided a [custom extension](https://github.com/errata-ai/MDX) to support it. | ||
|
||
If you'd prefer not to use this extension, we recommend the following lines in your `.vale.ini` file: | ||
```ini | ||
[formats] | ||
mdx = md | ||
|
||
[*.mdx] | ||
CommentDelimiters = {/*, */} | ||
|
||
TokenIgnores = (?sm)((?:import|export) .+?$), \ | ||
(?<!`)(<\w+ ?.+ ?\/>)(?!`), \ | ||
(<[A-Z]\w+>.+?<\/[A-Z]\w+>) | ||
|
||
BlockIgnores = (?sm)^(<\w+\n .*\s\/>)$, \ | ||
(?sm)^({.+.*}) | ||
``` | ||
|
||
To use Vale's in-document comments, use MDX-style comments `{/* ... */}`. | ||
If you use the `CommentDelimiters = {/*, */}` [setting](https://vale.sh/docs/keys/commentdelimiters) in your configuration, Vale will automatically interpret these comments while linting. | ||
This means you can easily use Vale's in-built features, like skipping lines or sections. | ||
|
||
```mdx | ||
{/* vale off */} | ||
|
||
This text will be ignored by Vale | ||
|
||
{/* vale on */} | ||
``` | ||
|
||
|
||
If you choose not to use `CommentDelimiters`, but still choose to use Vale's comments, you must wrap any Vale comments in MDX comments `{/* ... */}`. For example: | ||
|
||
```mdx | ||
{/* <!-- vale off --> */} | ||
|
||
This text will be ignored by Vale | ||
|
||
{/* <!-- vale on --> */} | ||
``` | ||
Please note that these commment tags are not supported within Mintlify components, but can be used anywhere at the base level of a document. |
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.
Uh oh!
There was an error while loading. Please reload this page.