Skip to content
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

Update contribution guidelines and add development section #81

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 39 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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 <name> --org-id <your-organization-id>
circleci orb create <my-namespace>/<my-orb-name> --private
circleci orb pack src > unity-orb.yml
circleci orb publish unity-orb.yml <my-namespace>/<my-orb-name>@dev:first
circleci orb publish promote <my-namespace>/<my-orb-name>@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="<your-namespace>"
export ORB_NAME="<your-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: <your-namespace>/<your-orb-name>@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)