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: about 1 year 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 (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-22T15:00:27.000Z (about 1 year ago)
- Last Synced: 2025-04-22T16:21:53.136Z (about 1 year ago)
- Topics: redmine, redmine-plugin
- Language: Shell
- Homepage:
- Size: 63.5 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Setup Redmine
[](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@0147e23d3e5516edf2a0d2cca095570283ca81b4 # v2.0.0
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
v5.0 or later
If you want to use it with Redmine v4.2, you can use `v1`.
## Example
### Setting up [RedMica](https://github.com/redmica/redmica)
```yaml
- uses: hidakatsuya/action-setup-redmine@0147e23d3e5516edf2a0d2cca095570283ca81b4 # v2.0.0
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:
```yaml
- uses: hidakatsuya/action-setup-redmine@0147e23d3e5516edf2a0d2cca095570283ca81b4 # v2.0.0
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