README

Tool for creating/syncing issue templates in git projects

Version: 1.1.0

Available templates:

• Default.md: Template for a feature request (use case, technical description, impacted modules, points of concern, estimations).
• Incident.md: Template for a bug

Install

composer require agencenous/git-templates --dev

Usage

From the project root:

vendor/bin/gitlab-templates

Templates are createed in .gitlab/issue_templates/.

Project Directory

The target project directory is defined in this order:

1. Option --project-dir / -d
2. composer.json key extra.git-templates-project-dir
3. Environment variable PROJECT_DIR
4. Default : current directory

Via composer.json

{
   "extra": {
     "git-templates-project-dir": "subdir"
   }
}

Repository Type

The repository type is defined in this order:

1. Option --repository-type / -r
2. composer.json key extra.git-templates-repository-type
3. Environment variable REPOSITORY_TYPE
4. Default : gitlab

Available repository types: gitlab, github, gitbucket.

Template destination by repository type:

• gitlab -> .gitlab/issue_templates
• github -> .github/ISSUE_TEMPLATE
• gitbucket -> .gitbucket/issue_templates

Examples

Command line:

vendor/bin/git-templates -r github

Via environment variable

REPOSITORY_TYPE=gitbucket vendor/bin/git-templates

Via composer.json

{
   "extra": {
     "git-templates-repository-type": "gitlab"
   }
}

Locale

The locale is defined in this order:

1. Option --locale / -l
2. composer.json key extra.git-templates-locale
3. Environment variable LANGUAGE
4. Default : en_US

Available locales: fr_FR, en_US.

Examples

Command line:

vendor/bin/git-templates -l fr_FR

Via environment variable

LANGUAGE=fr_FR vendor/bin/git-templates

Via composer.json

{
   "extra": {
     "git-templates-locale": "fr_FR"
   }
}

Options

Licence

GPL-3.0