Conformance is available on Enterprise plans
To set up Conformance in your repository, you must:
- Set up Vercel's private npm registry to install the necessary packages
- Install and initialize Conformance in your repository
- Add your repository to your Vercel dashboard
If you've already set up Boundaries or Code Owners, you may have already completed some of these steps.
To enable Conformance for your Enterprise team, you'll need to request access through your Vercel account administrator.
Note: Conformance is available for Enterprise teams. To add it to your contract or upgrade to Enterprise, contact us
Vercel distributes packages with the
@vercel-private scope through our private npm registry, and requires that each user using the package authenticates through a Vercel account.
To use the private npm registry, you'll need to follow the documentation to:
- Set up your local environment – This should be completed by the team owner, but each member of your team will need to log in
- Set up Vercel – This should be completed by the team owner
- Optionally, set up Conformance for use with CI – This should be completed by the team owner
This section guides you through setting up Conformance for your repository.
Use the CLI to automatically initialize Conformance in your project. Start by running this command in your repository's root:
pnpm --package=@vercel-private/conformance dlx vercel-conformance init
After running, check the installation success by executing:
init command creates the following changes:
- First, it installs the CLI package in your root
package.jsonand every workspace
package.json, if your monorepo uses workspaces.
- It also adds a
conformancescript to the
scriptsfield of every
package.json. This script runs Conformance.
- It adds any existing Conformance errors to allowlists, letting you start using Conformance without immediate fixes and allowing you to gradually resolve these allowlist entries over time. Learn more about Conformance Allowlists in the documentation.
Once you've reviewed these, open a pull request with the changes and merge it.
** This step assumes you have set up Code Owners.**
Conformance allows specific individuals to review modifications to allowlist files.
.vercel.approvers file at your repository's root:
Now, changes to allowlist files need a review from someone on
@org/team before merging.
Adding your repository to your team's Vercel dashboard, allows you to access the Conformance dashboard and see an overview of your Conformance stats.
Before you can connect a repository, you must ensure that the Vercel GitHub app has been installed for your team. You should ensure it is installed for either all repositories or for the repository you are trying to connect.
Once installed, you'll be able to connect your repository.
Connecting your repository brings you to the repository overview page.
To view the Conformance dashboard at any time: