/fvtt-cartographer

Primary LanguageJavaScriptMIT LicenseMIT

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.

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.

How to List Your Releases on Package Admin

To request a package listing for your first release, go to the Package Submission Form (accessible via a link at the bottom of the "Systems and Modules" page on the Foundry website).

Fill in the form. "Package Name" must match the name in the module manifest. Package Title will be the display name for the package. Package URL should be your repo URL. image

One of the Foundry staff will typically get back to you with an approval or any further questions within a few days, and give you access to the package admin pages.

Once you have access to the module admin page, you can release a new version by going into the page for your module, scrolling to the bottom, and filling in a new Package Version.

When listing a new version, Version should be the version number you set above, and the Manifest URL should be the manifest for that specific version (do not use /latest/ here). image

⚠️ Important ⚠️

It is very important that you use the specific release manifest url, and not the /latest url here. For more details about why this is important and how Foundry Installs/Updates packages, read this wiki article.

Clicking "Save" in the bottom right will save the new version, which means that anyone installing your module from within Foundry will get that version, and a post will be generated in the #release-announcements channel on the official Foundry VTT Discord.

FoundryVTT Module

Does something, probably

Changelog