Feature #36679

Export a version as changelog text

Added by Go MAEDA 9 months ago. Updated 3 months ago.

Status:NewStart date:
Priority:NormalDue date:
Assignee:-% Done:

0%

Category:Roadmap
Target version:Candidate for next major release
Resolution:

Description

I suggest a feature to export a version as text. One of the uses of the text is a changelog.

You will be able to get the text by clicking "Also available in: TXT" link placed in the bottom right of the version page.

If you export https://www.redmine.org/versions/5 as text, you will get the following output:

# Changelog

## 0.7.3

2008-07-06

Security+Bug fix release

* Defect #52: bulgarian language issue
* Defect #1426: User model does not allow person's first name to contain a dot '.'
* Feature #1506: Add title length note and error info when creating project or creating news
* Patch #1218: Patch for relative links to icon images in 'public/help/wiki_syntax.html'
* Patch #1425: Entourage (and some old client) fails to correctly render notification styles
* Patch #1524: back_url redirects inappropriately when blank
* Patch #1527: Add Project Name to Cross-Project Atom Feed

screenshot_2022-08-26_16_38_29.png (95.5 KB) Mizuki ISHIKAWA, 2022-08-26 09:39

feature-36679.patch Magnifier (3.43 KB) Mizuki ISHIKAWA, 2022-08-26 09:40

feature-36679-v2.patch Magnifier (3.53 KB) Go MAEDA, 2022-09-07 15:44

feature-36679-v3.patch Magnifier (3.52 KB) Go MAEDA, 2022-09-17 10:50


Related issues

Related to Redmine - Feature #1800: Changelog creator New 2008-08-19
Related to Redmine - Feature #7043: Give user ability to generate changelogs New 2010-12-04

History

#1 Updated by Go MAEDA 9 months ago

#2 Updated by Mizuki ISHIKAWA 9 months ago

+1

#3 Updated by Go MAEDA 9 months ago

  • Related to Feature #7043: Give user ability to generate changelogs added

#4 Updated by Mizuki ISHIKAWA 3 months ago

I have attached a patch to add this functionality.

#5 Updated by Go MAEDA 3 months ago

I made the following changes to the patch:

  • Add "*" at the beginning of each issue line
  • Fix the problem that the last issue line does not have trailing "\n"

#6 Updated by Go MAEDA 3 months ago

I updated the patches to use the version name instead of the id when exporting to a file.

Suppose that the id of the version is 2 and the name is "1.0". In this case, the filename of the exported text will be "version-2.txt". I think it is very confusing that the file name for exporting version "1.0" is "version-2.txt".

The new patch exports version "1.0" as "1.0.txt". This behavior is consistent with #16207.

#7 Updated by Mischa The Evil 3 months ago

Here are my thoughts based on feature-36679-v3.patch in case it is decided to add this to the Redmine core:
  • for clarity and consistency a colon should be added between the issue id and the subject (i.e. "* #{issue.tracker.name} ##{issue.id}: #{issue.subject}\n");
  • for consistency (with e.g. wiki pages) the link-text should be changed from "Text" to "TXT";
  • on a more general note: I don't think that the version_details_to_text method belongs in the Version model. I think it would be better to have it as a helper or as a method inside a dedicated 'export' module under source:/trunk/lib/redmine/export (this would also remove the need to include Redmine::I18n into the Version model).

Also available in: Atom PDF