Github action: Publish to Forgebox

This GitHub Action publishes your Github project to Forgebox.

Setup

Project secret variables

First off, you will need to create at least a single secret variable in your Github project for the action:

• FORGEBOX_PASS

See Creating encrypted secrets for a repository for a guide from Github.

This will be used to authenticate your user for publishing to Forgebox. You may also wish to hide your user name this way, but it is not essential.

Usage in Github actions workflow

Create a github workflow to publish your project (or add the steps below to your existing flows):

# .github/workflows/publish.yml
name: Publish to forgebox
# you may wish to trigger this for other specifics, this is an example
on: 
  push:
    tags: 
      - v*

jobs:
  publish:
    name: Publish to forgebox
    runs-on: ubuntu-latest
    steps:

    # this step gets your code checked out!
    - uses: actions/checkout@v2
        with:
          fetch-depth: 0
    
    # this is the usage of this box publish action
    - uses: pixl8/github-action-box-publish@v5
      with:
        forgebox_user: myforgeboxuser
        forgebox_pass: ${{ secrets.FORGEBOX_PASS }}
        force: "true"
        ignore_timeouts: "true"

Force publishing

In some scenarios, you may wish to pass the --force flag to the box publish command. The action can take a force parameter that should be set to true if you wish to force publishing (see above example).

Environment variable substition

By default, this action attempts to replace any variables in your box.json file with environment variables before publishing. For example, in your box.json you may have:

{
    "name":"Test package",
    "slug":"test-my-package",
    "type":"modules",
    "version":"${VERSION_NUMBER}",
    "location":"${DOWNLOAD_URL}"
}

Then, in your Github actions workflow you could do:

steps:
  - uses: actions/checkout@v2
    with:
      fetch-depth: 0
  
  # add extra steps here that set VERSION_NUMBER and 
  # DOWNLOAD_URL env vars

  - uses: pixl8/github-action-box-publish@v5
    with:
      forgebox_user: pixl8
      forgebox_pass: ${{ secrets.FORGEBOX_PASS }}
    env:
      DOWNLOAD_URL: ${{ env.DOWNLOAD_URL }}
      VERSION_NUMBER: ${{ env.VERSION_NUMBER }}

Additional env vars

DO_ENV_SUBSTITUTION

This defaults to true and means that you can pass in environment variables to replace in your box.json file before it is published (see above). Set this to false if you do not wish this substitution to run.

BOXJSON_DIR

If your box.json file does not live in the root of your project, set this variable to the directory that contains it, relative to the project root. e.g.

- uses: pixl8/github-action-box-publish@v5
  env:
    FORGEBOX_USER: pixl8
    FORGEBOX_PASS: ${{ secrets.FORGEBOX_PASS }}
    BOXJSON_DIR: /build

Note: must start with / and have no trailing slash.

License

This project is licensed under the GPLv2 License - see the LICENSE.txt file for details.

Authors

The project is maintained by The Pixl8 Group. The lead developer is Dominic Watson.

Code of conduct

We are a small, friendly and professional community. For the eradication of doubt, we publish a simple code of conduct and expect all contributors, users and passers-by to observe it.