Blame doc/usage/magic_words.rst

Pierre-Yves Chibon fa1c11
Magic Words
Pierre-Yves Chibon fa1c11
===========
Pierre-Yves Chibon fa1c11
Pierre-Yves Chibon fa1c11
Magic words are words and constructs you can use in your commit message to
Pierre-Yves Chibon fa1c11
make pagure act on tickets or pull-requests.
Pierre-Yves Chibon fa1c11
Pierre-Yves Chibon fa1c11
Enabling magic words
Pierre-Yves Chibon fa1c11
--------------------
Pierre-Yves Chibon fa1c11
Pierre-Yves Chibon fa1c11
These magic words are enabled if the ``pagure`` git hook is enable. To do
Pierre-Yves Chibon fa1c11
so, go to your project's ``settings`` page, open the ``Hooks`` tab and
Pierre-Yves Chibon fa1c11
activate there the ``Pagure`` hook.
Pierre-Yves Chibon fa1c11
Pierre-Yves Chibon fa1c11
Pierre-Yves Chibon fa1c11
Using magic words
Pierre-Yves Chibon fa1c11
-----------------
Pierre-Yves Chibon fa1c11
Pierre-Yves Chibon fa1c11
To reference an issue/PR you need to use one of recognized keywords followed by
Pierre-Yves Chibon fa1c11
a reference to the issue or PR, separated by whitespace and and optional colon.
Pierre-Yves Chibon fa1c11
Such references can be either:
Pierre-Yves Chibon fa1c11
Pierre-Yves Chibon fa1c11
- The issue/PR number preceded by the # symbol
Pierre-Yves Chibon fa1c11
- The full URL of the issue or PR
Pierre-Yves Chibon fa1c11
Pierre-Yves Chibon fa1c11
If using the full URL, it is possible to reference issues in other projects.
Pierre-Yves Chibon fa1c11
Pierre-Yves Chibon fa1c11
The recognized keywords are:
Pierre-Yves Chibon fa1c11
Pierre-Yves Chibon fa1c11
- fix/fixed/fixes
Pierre-Yves Chibon fa1c11
- relate/related/relates
Pierre-Yves Chibon fa1c11
- merge/merges/merged
Pierre-Yves Chibon fa1c11
- close/closes/closed
Pierre-Yves Chibon 1a7dcb
- resolve/resolves/resolved
Pierre-Yves Chibon fa1c11
Pierre-Yves Chibon fa1c11
Examples:
Pierre-Yves Chibon fa1c11
Pierre-Yves Chibon fa1c11
- Fixes #21
Pierre-Yves Chibon fa1c11
- related: https://pagure.io/myproject/issue/32
Pierre-Yves Chibon fa1c11
- this commit merges #74
Pierre-Yves Chibon fa1c11
- Merged: https://pagure.io/myproject/pull-request/74
Pierre-Yves Chibon fa1c11
Pierre-Yves Chibon fa1c11
Capitalization does not matter; neither does the colon (``:``) between
Pierre-Yves Chibon fa1c11
keyword and number.