CI Pipeline for PR Validation
With every commit pushed to an open PR branch, the following CI checks are queued:
license/cla
- Ensure you have signed Microsoft's Contributor License Agreementrepo-policy-check
- Ensure certain policies around file metadata, naming sorting, etc are adhered to- Various
Build - ...
checks - Depending on which directories are touched, the corresponding build/test tasks will be run
If a check failed, click the "details" link for the checks. This will take you to a page on GitHub with a bit more information, and a link to the Azure Dev Ops portal where the checks were executed.
Repo Policy Check
If repo-policy-check
fails, you can run it locally like this (from the repo root):
npm run policy-check
Some failures can be auto-resolved by running npm run policy-check:fix
Beware that some behaviors (e.g. file path case sensitivities) differ between OS's, so running locally on Windows may yield different results than the Linux CI machines.
license/cla flakiness
If the license/cla
check hangs (takes more than about 1 minute), try closing/reopening your PR.
CI Pipeline for main/release branch Validation
Once a change is merged into main
or a release
branch, the CI loop kicks off several builds and other checks, similar to the PR checks. Microsoft employees can view these runs here. To monitor the official build for a particular commit, just look for the pipeline runs labeled something like "Individual CI for main" with the commit message also listed.
Once the relevant build has succeeded, you may update a dependency on the built packages to the pre-release version (ending in -0
) and run npm i
at which point you'll be pulling in the pre-release version of the dependency containing the change in question.
Overview
Contributing
- Submitting Bugs and Feature Requests
- Contributing to the Repo
- Repo Basics
- Common Workflows and Patterns
- Managing dependencies
- Client Code
- Server Code
- PR Guidelines
- CI Pipelines
- Breaking vs Non-Breaking Changes
- Branches, Versions, and Releases
- Compatibility & Versioning
- Testing
- Debugging
- npm package scopes
- Maintaining API support levels
- Developer Tooling Maintenance
- API Deprecation
- Working with the Website (fluidframework.com)
- Coding Guidelines
- Documentation Guidelines
- CLA
Using Fluid Framework
This wiki is focused on contributing to the Fluid Framework codebase.
For information on using Fluid Framework or building applications on it, please refer to fluidframework.com.