Giter Club home page Giter Club logo

redmine_issue_templates's Introduction

Redmine Issue Templates Plugin

Plugin info at redmine.org CircleCI Sider

Plugin to generate and use issue templates for each project to assist issue creation. For Redmine 2.1.x or higher, please use version 0.0.4 or higher. For Redmine 2.0, please use version 0.0.3 or higher.

Repository

Plugin installation

  1. Copy the plugin directory into the $REDMINE_ROOT/plugins directory. Please note that plugin's folder name should be "redmine_issue_templates". If changed, some migration task will be failed.

  2. Do migration task.

    e.g. rake redmine:plugins:migrate RAILS_ENV=production

  3. (Re)Start Redmine.

Uninstall

Try this:

  • rake db:migrate_plugins NAME=redmine_issue_templates VERSION=0 RAILS_ENV=production

See also: http://www.r-labs.org/projects/issue-template/wiki/About_en#Uninstall-plugin

Required Settings

  1. Login to your Redmine install as an Administrator

  2. Enable the permissions for your Roles:

    • Show issue templates: User can show issue templates and use templates when creating/updating issues.
    • Edit issue templates: User can create/update/activate templates for each project.
    • Manage issue templates: User can edit help message of templates for each project.
  3. Enable the module "Issue Template" on the project setting page.

  4. The link to the plugin should appear on that project's navigation.

Note

This plugin aims to assist contributor's feedback by using template if the project has some format for issues.

Troubleshoot for bundle intall and startup problem

This plugin repository includes some test code and gem settiing. If you have some trouble related "bundle intall", please try --without option.

Exp. bundle install --without test

WebPage

If you have any requests, bug reports, please use GitHub issues. https://github.com/akiko-pusu/redmine_issue_templates

Description and usage info

Changelog

0.3.1

  • Basic feature implemented of note template.
  • Enabled to use issue templates when updating issue.
    • Go to global template admin setting, and turn on "apply_template_when_edit_issue" flag.
  • Bugfix: Prevent conflict against issue controller helper. (#217)
  • Update readme: Merged PR #219. Thanks Arnaud Venturi!

NOTE: This version requires migration command to use note template feature.

$ rake redmine:plugins:migrate RAILS_ENV=production

0.3.0

  • Support Redmine 4.x.
    • Now master branch unsupports Redmine 3.x.
    • Please use ver 0.2.x or v0.2.x-support-Redmine3 branch in case using Redmine3.x.
  • Follow Redmine's preview option to the wiki toolbar.
  • Show additional navigation message when plugin is applied to Redmine 3.x.

NOTE: Mainly, maintenance, bugfix and refactoring only. There is no additional feature, translation in this release. Thank you for creating patch, Mizuki Ishikawa!

0.2.1

Mainly, bugfix and refactoring release. Updating to 0.2.1 is highly recommended in case using CKEditor or MySQL replication. NOTE: Migration is required, especially using MySQL replication.

  • Bugfix: Fix "Page not found" error when try to create project template from project setting. (GitHub: #192, #199)
  • Bugfix: Add composite unique index to support MySQL group replication. (GitHub: #197)
  • Workaround: Wait fot 200 msec until CKE Editor's ajax callback done. (GitHub: #193)
  • Add feature to hide confirmation dialog when overwritten issue subject and description, with using user cookie. (GitHub: #190)
  • Refactoring: Minitest and so on.

A cookie named "issue_template_confirm_to_replace_hide_dialog" is stored from this release. (Related: #190)

0.2.0

Bugfix and refactoring release. Updating from v0.1.9 to 0.2.0 is highly recommended. In this release, some methods which implemented on Redmine v3.3 are ported for plugin's compatibility. (To support Redmine 3.0 - 3.4)

  • Bugfix: Prevent to call unimplemened methods prior to Redmine3.2. (GitHub: #180)
  • Refactoring: Code format. (JS, CSS) / Update config for E2E test.
  • Updated Simplified Chinese translation, thanks Steven.W. (GitHub PR: #179)
  • Applied responsive layout against template list (index) page.

Thank you for reviewing, Tatsuya Saito!

Language and I18n contributors

  • Brazilian: Adriano Ceccarelli / Pedro Moritz de Carvalho Neto
  • Korean: Jaebok Oh
  • Chinese: Steven Wong
  • Bulgarian: Ivan Cenov
  • Russian: Denny Brain, danaivehr
  • German: Terence Miller and anonymous contributor
  • French: Anonymous one
  • Serbian: Miodrag Milic
  • Polish: Paweł Budikom and Krzysztof Wosinski
  • Spanish: Andres Arias
  • Italian: Luca Lesinigo
  • Danish: AThomsen

Rake Tasks

You can see rake task, with (bundle exec) rake -T, related to this plugin.

Exp.

# Apply inhelit template setting to child projects
$ rake redmine_issue_templates:apply_inhelit_template_to_child_projects[project_id]

# Run test for redmine_issue_template plugin
$ rake redmine_issue_templates:default

# Run spec for redmine_issue_template plugin
$ rake redmine_issue_templates:spec

# Run tests
$ rake redmine_issue_templates:test

# Unapply inhelit template setting from child projects
$ rake redmine_issue_templates:unapply_inhelit_template_from_child_projects[project_id]

# Generate YARD Documentation for redmine_issue_template plugin
$ rake redmine_issue_templates:yardoc

You can apply/unapply inherit templates for all the hild projects.

rake redmine_issue_templates:apply_inhelit_template_to_child_projects[project_id]      # Apply inhelit template setting to child projects
rake redmine_issue_templates:unapply_inhelit_template_from_child_projects[project_id]  # Unapply inhelit template setting from child projects

If you want to apply inherit templates setting all the child project of project_id: 1 (as parent project), please run rake command like this:

rake redmine_issue_templates:apply_inhelit_template_to_child_projects[1]

Run test

Please see wercker.yml for more details.

% cd REDMINE_ROOT_DIR
% cp plugins/redmine_issue_templates/Gemfile.local plugins/redmine_issue_templates/Gemfile
% bundle install --with test
% export RAILS_ENV=test
% bundle exec ruby -I"lib:test" -I plugins/redmine_issue_templates/test plugins/redmine_issue_templates/test/functional/issue_templates_controller_test.rb 

or

% bundle exec rake redmine_issue_templates:test

Run spec

Please see wercker.yml for more details.

% cd REDMINE_ROOT_DIR
% cp plugins/redmine_issue_templates/Gemfile.local plugins/redmine_issue_templates/Gemfile
% bundle install --with test
% export RAILS_ENV=test
% bundle exec rspec -I plugins/redmine_issue_templates/spec --format documentation plugins/redmine_issue_templates/spec/

By default, use chrome as a webdriver. If you set environment variable 'DRIVER' to 'headless', headless_chrome is used.

% bundle exec rspec -I plugins/redmine_issue_templates/spec --format documentation plugins/redmine_issue_templates/spec/ DRIVER='headless'

License

This software is licensed under the GNU GPL v2.

redmine_issue_templates's People

Contributors

akiko-pusu avatar archonwang avatar taqueci avatar pedromoritz avatar two-pack avatar ishikawa999 avatar adrianobr avatar tofi86 avatar jwciss avatar athomsen avatar toadjaune avatar jwalkerbg avatar lesinigo avatar ardahaal avatar robbforce avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.