Skip to content

Commit

Permalink
Update to support newer version of the packaging tool
Browse files Browse the repository at this point in the history
  • Loading branch information
Cibbi committed Oct 22, 2023
1 parent 4b45082 commit 6736cf1
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 5 deletions.
43 changes: 38 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,20 @@
<div align="center">

# VRC Packaging Action
[![Generic badge](https://img.shields.io/github/release/VRLabs/VRC-Packaging-Action?display_name=tag&label=Release)](https://github.com/VRLabs/VRC-Packaging-Action/releases/latest)
[![Generic badge](https://img.shields.io/badge/License-MIT-informational.svg)](https://github.com/VRLabs/VRC-Packaging-Action/blob/main/LICENSE)

This GitHub Action packages Unity assets in both `unitypackage` and `vcc` package formats. It is based on the `vrctools-packaging` Docker image.
[![Generic badge](https://img.shields.io/github/release/VRLabs/VRCTools-Packaging-Action?display_name=tag&label=Release)](https://github.com/VRLabs/VRCTools-Packaging-Action/releases/latest)
[![Generic badge](https://img.shields.io/badge/License-MIT-informational.svg)](https://github.com/VRLabs/VRCTools-Packaging-Action/blob/main/LICENSE)

[![Generic badge](https://img.shields.io/discord/706913824607043605?color=%237289da&label=DISCORD&logo=Discord&style=for-the-badge)](https://discord.vrlabs.dev/)
[![Generic badge](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fshieldsio-patreon.vercel.app%2Fapi%3Fusername%3Dvrlabs%26type%3Dpatrons&style=for-the-badge)](https://patreon.vrlabs.dev/)

GitHub Action to package Unity assets in both `unitypackage` and `vcc` package formats. It is based on the VRLabs [`VRC Packaging Tool`](https://github.com/VRLabs/VRCTools-Packaging).

### ⬇️ [Check out on the Github Action Marketplace](https://github.com/marketplace/actions/vrc-packaging-action)

</div>

---

## Inputs

Expand All @@ -18,6 +30,10 @@ This GitHub Action packages Unity assets in both `unitypackage` and `vcc` packag

The release URL to set in the `package.json`.

### `unityReleaseUrl`

The release URL to set in the `package.json` for the unitypackage version.

### `noVcc`

Skips the build of the `vcc` package, the `package.json` will not contain an url for the unitypackage version.
Expand Down Expand Up @@ -47,7 +63,7 @@ uses: VRLabs/VRCTools-Packaging-Action@v1
with:
path: 'Path/To/Asset'
outputPath: 'Packages'
releaseUrl: 'https://github.com/User/Asset/releases/download/master/package.id-x.x.x.zip'
releaseUrl: 'https://url/to/package.id-x.x.x.zip'
```
## VCC only example
Expand All @@ -58,10 +74,14 @@ uses: VRLabs/VRCTools-Packaging-Action@v1
with:
path: 'Path/To/Asset'
outputPath: 'Packages'
releaseUrl: 'https://github.com/User/Asset/releases/download/master/package.id-x.x.x.zip'
releaseUrl: 'https://url/to/package.id-x.x.x.zip'
noUnityPackage: 'true'
```
## Contributors
* [Cibbi](https://github.com/Cibbi)
## License
VRLabs VRC Packaging Action is available as-is under MIT. For more information see [LICENSE](https://github.com/VRLabs/VRC-Packaging-Action/blob/main/LICENSE).
Expand All @@ -70,3 +90,16 @@ VRLabs VRC Packaging Action is available as-is under MIT. For more information s
If you need help, our support channel is on [Discord](https://discord.vrlabs.dev).
<div align="center">
[<img src="https://github.com/VRLabs/Resources/raw/main/Icons/VRLabs.png" width="50" height="50">](https://vrlabs.dev "VRLabs")
<img src="https://github.com/VRLabs/Resources/raw/main/Icons/Empty.png" width="10">
[<img src="https://github.com/VRLabs/Resources/raw/main/Icons/Discord.png" width="50" height="50">](https://discord.vrlabs.dev/ "VRLabs")
<img src="https://github.com/VRLabs/Resources/raw/main/Icons/Empty.png" width="10">
[<img src="https://github.com/VRLabs/Resources/raw/main/Icons/Patreon.png" width="50" height="50">](https://patreon.vrlabs.dev/ "VRLabs")
<img src="https://github.com/VRLabs/Resources/raw/main/Icons/Empty.png" width="10">
[<img src="https://github.com/VRLabs/Resources/raw/main/Icons/Twitter.png" width="50" height="50">](https://twitter.com/vrlabsdev "VRLabs")
</div>
7 changes: 7 additions & 0 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,11 @@ inputs:
description: 'The release url to set in the package.json'
required: false
default: ''

unityReleaseUrl:
description: 'The unity release url to set in the package.json'
required: false
default: ''

noVcc:
description: 'Do not build the vcc package'
Expand All @@ -44,6 +49,8 @@ runs:
- ${{ inputs.outputPath }}
- '--releaseUrl'
- ${{ inputs.releaseUrl }}
- '--unityReleaseUrl'
- ${{ inputs.unityReleaseUrl }}
- '-novcc'
- ${{ inputs.noVcc }}
- '-nounity'
Expand Down

0 comments on commit 6736cf1

Please sign in to comment.