Issue Task Closed

#77840Optimize Changelogs: Add links to Forge

Martin Bless 09/04/16, 15:56 updated 10/17/17, 23:24

Description

This is a follow up to task #77787.
I’ll send a patch for review.

Understanding the background

In reST we can define custom textroles for link generation. See http://www.sphinx-doc.org/en/stable/ext/extlinks.html

Until now we have defined `:forge:`77787` that generates a links to forge that looks like `Forge #77787` and links to https://forge.typo3.org/issues/77787 And we have `:review:49759` that looks like `Review #49759` and links to https://review.typo3.org/#/c/49759/.

Add links to Forge

Each change is described in a file of its own and as a document title that contains the corresponding Forge number. Thus it seems natural to to add a link to forge directly beneath that headline. The envisioned patch will exactly do that.

How to create those links easily

To insert the text I used a global regexed search and replace in PyCharm. It should work in PhpStorm just the same.

Search for ```(+)\n.*?#(\d\d\d\d\d).*\n\1\n\n```

Replace by ```$1$2$3$4$1\n\nSee :forge:`$3`\n\n```

The dialogue: 086.png

And this is, for example, how the result looks like: 087.png

Patch for review will follow.

Reviews 2