diff --git a/README.md b/README.md index 04113a4..8a78cea 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ Easily build and test your Unity project. ### How to Contribute -We welcome [issues](https://github.com/game-ci/unity-orb/issues) to and [pull requests](https://github.com/game-ci/unity-orb/pulls) against this repository! +We welcome [issues](https://github.com/game-ci/unity-orb/issues) and [pull requests](https://github.com/game-ci/unity-orb/pulls) against this repository! For detailed guidelines, see [CONTRIBUTING.md](./CONTRIBUTING.md). ### How to Publish An Update @@ -32,15 +32,43 @@ We welcome [issues](https://github.com/game-ci/unity-orb/issues) to and [pull re 6. Click _"Publish Release"_. - This will push a new tag and trigger your publishing pipeline on CircleCI. -### Manual Deploy +## Development and Manual Deploy -If you want a private orb for your build env. The following steps allow you to do so. These are adapted from the CircleCI -[Manual Orb Authoring Process](https://circleci.com/docs/orb-author-validate-publish/#publish-your-orb) +> **Note:** Development and private orbs should only be used for testing purposes. Always review and validate changes thoroughly before using in production. -```bash -circleci namespace create --org-id -circleci orb create / --private -circleci orb pack src > unity-orb.yml -circleci orb publish unity-orb.yml /@dev:first -circleci orb publish promote /@dev:first patch -``` +If you want to contribute to this orb or deploy a private version for testing, follow these steps: + +1. **Fork this repository (optional for private orbs).** +2. **Set your namespace and orb name** to make the steps easier: + + ```bash + export NAMESPACE="" + export ORB_NAME="" + export VERSION="dev:first" + ``` + +3. **Pack and publish your orb:** + + ```bash + circleci orb pack src > unity-orb.yml + circleci orb publish unity-orb.yml "$NAMESPACE/$ORB_NAME@$VERSION" + ``` + +4. **Use your orb in your CircleCI workflow:** + + Update your `.circleci/config.yml` to reference your custom version: + + ```yaml + orbs: + unity: /@dev:first + ``` + +5. **Promote the version** to a higher semantic version if needed (optional): + + ```bash + circleci orb publish promote "$NAMESPACE/$ORB_NAME@$VERSION" patch + ``` + +## License + +[MIT](LICENSE)