Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document Conventional Commits closing keywords for Git commits #1588

Merged
merged 2 commits into from
Jan 6, 2025
Merged

Document Conventional Commits closing keywords for Git commits #1588

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fcef09a
Document Conventional Commits closing keywords for Git commits
Hyzual Jan 6, 2025
369cd30
Changes from review
Hyzual Jan 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions languages/en/user-guide/code-versioning/git.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -325,12 +325,12 @@ The following keywords (case insensitive) can be used to close an artifact:
* ``Fixes`` art #123
* ``Implements`` art #123

Some variations of these keywords are handled:
Some variations of these keywords are allowed, including some from `Conventional Commits <https://www.conventionalcommits.org/en/v1.0.0/>`_:

* ``Close``/``Fix``/``Resolve``/``Implement``
* ``Closes``/``Fixes``/``Resolves``/``Implements``
* ``Closed``/``Fixed``/``Resolved``/``Implemented``
* ``Closing``/``Fixing``/``Resolving``/``Implementing``
* ``Close``/``Closes``/``Closed``/``Closing``/``chore:``
* ``Fix``/``Fixes``/``Fixed``/``Fixing``/``fix:``
* ``Implement``/``Implements``/``Implemented``/``Implementing``/``feat:``
* ``Resolve``/``Resolves``/``Resolved``/``Resolving``

When all those conditions are met, the referenced artifact's status will be changed to the first valid :ref:`"Done" semantic <done-semantic>` value. If the "Done" semantic is not defined, the first "closed" value (per "Status" semantic configuration) will be used. The artifact will be closed by a Tuleap bot named ``Tracker Workflow Manager`` with a follow-up comment explaining why it has been closed.

Expand Down
2 changes: 1 addition & 1 deletion languages/en/user-guide/trackers/usage/notification.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ access the artifact form on Tuleap.
Notification by @ mention
=========================

In :ref:`Tracker Artifact comments <artifact_comments>`, when you mention somebdy by their Tuleap username, they will also receive an e-mail notification.
In :ref:`Tracker Artifact comments <artifact_comments>`, when you mention somebody by their Tuleap username, they will also receive an e-mail notification.

This is a one-time notification, people who are notified by their username will not receive updates for new comments or changes to the artifact.

Expand Down