Giter Club home page Giter Club logo

foundryvtt-publish-package-action's Introduction

FoundryVTT publish package action

This action allow you to publish a package on the FoundryVTT website.

Inputs

Required

token

Package Release Token - Found accessing the edit page of your package on the FoundryVTT website.

manifest

The required string for the URL of your package manifest. Please Note: This is not the package manifest URL in your package manifest, which should be pointed to a latest branch. Instead, it should point to a specific release to allow users to download this specific version of your package.

Optional

dry-run

Do a dry-run. The API will validate and process your request, but not save any changes. Default "false".

id

The required ID of your package, as listed in your package manifest.

version

The required string representing the package version number. A semantic version number is preferred, such as 1.0.0.

notes

The optional string for the URL of your release notes for this version of your package. As with your manifest URL, we prefer this to be a discrete list of changes for this release for ease of accessing the most up-to-date, correct information.

compatibility-minimum

The required string for the Foundry version before which this module cannot function. This prevents installation for users on these incompatible versions.

compatibility-verified

The required string for the most recent Foundry version during which this module has been verified to work correctly. This is a suggestion to users to run either exactly or at most this version of Foundry when installing the module, but will not prevent installation.

compatibility-maximum

The optional string for the Foundry version which this module has been verified to no longer function. We recommend not setting this value unless you have tested or received reports about your module no longer working in a recent version of Foundry, as it will prevent installation for any user at or after that version. As with minimum, this prevents installation for users on these incompatible versions.

Example usage

Minimum example

Only passing the release token and the manifest URL. All others data are taken from the manifest.

uses: djlechuck/foundryvtt-publish-package-action@v1
with:
    token: ${{ secrets.FOUNDRYVTT_RELEASE_TOKEN }}
    manifest: 'https://github.com/example/example-module/issues/releases/download/release-1.0.0/system.json'

Complete example

Passing all the options. The manifest will not be read.

uses: djlechuck/foundryvtt-publish-package-action@v1
with:
    token: ${{ secrets.FOUNDRYVTT_RELEASE_TOKEN }}
    id: 'example-module'
    version: '1.0.0'
    manifest: 'https://github.com/example/example-module/issues/releases/download/release-1.0.0/system.json'
    notes: 'https://github.com/example/example-module/releases/tag/release-1.0.0'
    compatibility-minimum: '11'
    compatibility-verified: '11.315'

foundryvtt-publish-package-action's People

Contributors

djlechuck avatar

Watchers

 avatar  avatar

foundryvtt-publish-package-action's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.