https://github.com/hidakatsuya/action-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.
https://github.com/hidakatsuya/action-setup-redmine

redmine redmine-plugin

Last synced: 2 months ago
JSON representation

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.

• Host: GitHub
• URL: https://github.com/hidakatsuya/action-setup-redmine
• Owner: hidakatsuya
• License: mit
• Created: 2024-05-12T08:23:25.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-07-18T04:35:30.000Z (5 months ago)
• Last Synced: 2024-10-10T03:43:15.324Z (2 months ago)
• Topics: redmine, redmine-plugin
• Language: Shell
• Homepage:
• Size: 49.8 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Setup Redmine

[![Build](https://github.com/hidakatsuya/action-setup-redmine/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/hidakatsuya/action-setup-redmine/actions/workflows/build.yml)

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

```yaml

- uses: hidakatsuya/action-setup-redmine@v1

  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](./action.yml).

## Supported Redmine version

v4.2 or later

## Example

### Setting up [RedMica](https://github.com/redmica/redmica)

```yaml

- uses: hidakatsuya/action-setup-redmine@v1

  with:

    repository: 'redmica/redmica'

    version: 'v2.4.2'

    database: 'postgres:14'

    ruby-version: '3.2'

```

### 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:

```yaml

- uses: hidakatsuya/action-setup-redmine@v1

  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](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md).

## 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