Setup Redmine

This action installs Redmine and sets up an environment to run tests. It is primarily aimed at providing an environment to run tests for Redmine plugins.

Usage

- uses: hidakatsuya/action-setup-redmine@v2
  with:
    # Redmine repository to setup. Default is redmine/redmine.
    repository: 'redmine/redmine'

    # The branch, tag or commit to checkout. Default is master.
    version: 'master'

    # Database to use for testing. Possible values are sqlite3 or
    # PostgreSQL and MySQL Docker official image tags (e.g. postgres:14, mysql:8.1.0). Default is sqlite3
    database: 'sqlite3'

    # Ruby version to use for testing. See ruby/setup-ruby's ruby-version input for available versions.
    ruby-version: '3.3'

    # Directory to setup Redmine. Default is the current directory.
    path: '.'

See also action.yml.

Supported Redmine version

v5.0 or later

If you want to use it with Redmine v4.2, you can use v1.

Example

Setting up RedMica

- uses: hidakatsuya/action-setup-redmine@v2
  with:
    repository: 'redmine/redmine'
    version: 'v6.0.1'
    database: 'postgres:14'
    ruby-version: '3.3'

Run a test for the Redmine plugin

For example, you are developing the redmine_hello_world plugin on GitHub repository. To run a test for that plugin in GitHub Action, do the following:

- uses: hidakatsuya/action-setup-redmine@v2
  with:
    ruby-version: '3.3'

- uses: action/checkout@v4
  with:
    path: plugins/redmine_hello_world

- run: |
    bundle install
    bin/rails redmine:plugins:test NAME=redmine_hello_world

Versioning

This action follows the recommendations of GitHub Actions Versioning.

Releasing

1. Make sure CI for main branch has passed
2. Create a new release to publish to the GitHub Marketplace
3. Make sure that the release workflow has passed