cakephp / cakephp/phinx

No documentation for templates field in configuration file

Open
#972 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs
Dominant language
PHP
Stars
4.5k
Forks
884
PR merge metrics
No merged PRs in 30d

Description

From docs:

Open the new migration file in your text editor to add your database transformations. Phinx creates migration files using the path specified in your phinx.yml file. Please see the Configuration chapter for more information.

In configuration chapter there is no reference to the templates.file field, this is the documentation about "templates":

Aliases
Template creation class names can be aliased and used with the --class command line option for the Create Command.
The aliased classes will still be required to implement the Phinx\Migration\CreationInterface interface.

I had to check the code to realized that I can change the template of every new migration by adding this in my config file:

templates:
    file: %%PHINX_CONFIG_DIR%%/templates/my.template

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Configuration chapter referenced in the issue and compare its existing “templates” documentation with the configuration example. Document the templates.file field, including that it controls the template used for new migrations and supports the shown path value. Done when users can find and understand this setting in the configuration documentation.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.