jmhnilbog / FoundryVTT-Module-Template

A template repository for FoundryVTT module development that comes with versioned CI/CD

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

How to use this Template to create a versioned Release

  1. Open your repository's releases page.

Where to click to open repository releases.

  1. Click "Draft a new release"

Draft a new release button.

  1. Fill out the release version as the tag name.

Do not prefix your tag name with a v.

If you want to add details at this stage you can, or you can always come back later and edit them.

Release Creation Form

  1. Hit submit.

  2. Wait a few minutes.

A Github Action will run to populate the module.json and module.zip with the correct urls that you can then use to distribute this release. You can check on its status in the "Actions" tab.

Actions Tab

  1. Grab the module.json url from the release's details page.

image

This module.json will only ever point at this release's module.zip, making it useful for sharing a specific version for compatibility purposes.

  1. You can use the url https://github.com/<user>/<repo>/releases/latest/download/module.json to refer to the manifest.

This is the url you want to use to install the module typically, as it will get updated automatically.

FoundryVTT Module

Does something, probably

Changelog

About

A template repository for FoundryVTT module development that comes with versioned CI/CD

License:MIT License


Languages

Language:JavaScript 100.0%