Skip to content

Commit

Permalink
Merge pull request #10 from vrchat-community/bugfix/dont-make-auto-re…
Browse files Browse the repository at this point in the history
…leases

Changes releases to be manual
  • Loading branch information
momo-the-monster authored Jul 26, 2023
2 parents 305de49 + 0906219 commit 483e898
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 8 deletions.
3 changes: 0 additions & 3 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@ name: Build Release

on:
workflow_dispatch:
push:
branches: main
paths: Packages/com.vrchat.demo-template/**

env:
packageName: "com.vrchat.demo-template"
Expand Down
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,7 @@ Full details at [Converting Assets to a VPM Package](https://vcc.docs.vrchat.com

## Setting up the Automation

You'll need to make a few changes in [release.yml](.github/workflows/release.yml):
* Change the `paths` property on line 7 to point to the directory where your package's source files are. Leave the `/**` at the end so GitHub knows to run this action whenever any file in that directory is changed.
* In the template, this property is `paths: Packages/com.vrchat.demo-template/**`
You'll need to make a change in [release.yml](.github/workflows/release.yml):
* Change the `packageName` property on line 10 to include the name of your package, like `packageName: "com.vrchat.demo-template"`

You'll also need to make a change to [build-listing.yml](.github/workflows/build-listing.yml):
Expand All @@ -53,11 +51,11 @@ Some other notes:

## 🎉 Publishing a Release

A release will be automatically built whenever you push changes to your main branch which update files in the package folder you specified in `release.yml`. The version specified in your `package.json` file will be used to define the version of the release.
You can make a release by running the [Build Release](.github/workflows/release.yml) action. The version specified in your `package.json` file will be used to define the version of the release.

## 📃 Rebuilding the Listing

Whenever you make a change to a release - automatically publishing it, or manually creating, editing or deleting one, the [Build Repo Listing](.github/workflows/build-listing.yml) action will make a new index of all the releases available, and publish them as a website hosted fore free on [GitHub Pages](https://pages.github.com/). This listing can be used by the VPM to keep your package up to date, and the generated index page can serve as a simple landing page with info for your package. The URL for your package will be in the format `https://username.github.io/repo-name`.
Whenever you make a change to a release - manually publishing it, or manually creating, editing or deleting a release, the [Build Repo Listing](.github/workflows/build-listing.yml) action will make a new index of all the releases available, and publish them as a website hosted fore free on [GitHub Pages](https://pages.github.com/). This listing can be used by the VPM to keep your package up to date, and the generated index page can serve as a simple landing page with info for your package. The URL for your package will be in the format `https://username.github.io/repo-name`.

## 🏠 Customizing the Landing Page

Expand Down

0 comments on commit 483e898

Please sign in to comment.