- Node 16+
- pnpm 7.5.2+
See usage docs
This project uses pnpm workspaces to manage multiple packages.
- Install dependencies
pnpm install
- Build
pnpm build
- Build in watch mode(rebuild automatically on save)
pnpm watch
Docs on writing scenarios specs Docs on writing mock apis
pnpm clean
pnpm generate-scenarios-summary
- Cadl Ranch Specs to work on scenarios and/or mock apis.
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.
Make sure you run the following command to prepare the pr:
pnpm pr-prep
This will run all of the following commands for you however you can run each individually if needed:
pnpm validate-scenarios
pnpm validate-mock-apis
pnpm generate-scenarios-summary
pnpm format
pnpm cspell
Once the change passes the above validate you can add the changeset
pnpm changeset add
orpnpm changeset add --empty
Go through PR checklist
Semi-auto:
Branch publish/auto-release
should be automatically updated with the latest changelog. Give it 5min after merging a PR or check the status of the Release action
Then go to https://github.com/Azure/cadl-ranch/pull/new/publish/auto-release and create this PR.
Manual
- Run
pnpm changeset version
to bump the versions according to the changesets. - Make a new branch called
publish/<xyz>
- Make a PR and merge
- The packages with a new version should get automatically bumped
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.