Skip to content

A Github action that packs FoundryVTT db files for release

License

Notifications You must be signed in to change notification settings

aMediocreDad/foundry-db-packer

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

FoundryVTT Release DB Packer

A Github Action that packs JSON files generated by the FoundryVTT CLI into compendium pack databases for release.

Usage

Warning

This action does not work with Windows runners.

Example workflow

# .github/workflows/release.yml
name: Release
on:
    push:
        tags:
            - "v*.*.*"
jobs:
    release:
        runs-on: ubuntu-latest
        steps:
            - name: Checkout
              uses: actions/checkout@v2
            - name: Create Database Packs
              uses: aMediocreDad/foundry-db-packer@v0.2.1
              with:
                  inputdir: # The directory which contains the JSON files to pack (required)
                  packsdir: packs/ # The directory where the compendium packs should exist (optional)
                  pack_classiclevel: true # <boolean> Whether to pack the class level db files (optional)
                  pack_nedb: false # <boolean> Whether to pack the nedb db files (optional)


        # Do something with the database packs

Developing

This action uses @changesets/cli for versioning, esbuild for building and vitest for testing.