search

bitprophet / releases

A powerful Sphinx changelog-generating extension.
http://releases.readthedocs.io/
BSD 2-Clause "Simplified" License
176 stars 41 forks source link

Support for tags #38

Open xintron opened 9 years ago

xintron commented 9 years ago

We are using releases for a number of projects (non-libraries) and often want to label which project a specific issues relates to. Currently this is done like so: :bug:DD-200*(ProjectA)* Just a flesh wound.

Would it be possible to perhaps get native support for tags/labels where it could also add the CSS class tag-<input-tag> for optional styling? This to get one big changelog for all projects instead of having one for each.

Edit: My initial thought was to support :bug:DD-200 major [projectA, projectB]`` to support multiple labels.

bitprophet commented 9 years ago

Thanks, seems like a legit use case, tho I am not entirely sure how best to add it to the mini-language that is the issue specifier. Your suggestion might work but I wonder if there's a syntax that is easier to parse/write.

Slightly related is #34 though that's more about a separate "type" of issue, versus just styling. But the need may be similar.

svetlyak40wt commented 8 years ago

By the way, I thought about something like tags but for other purpose – I want to keep one stream for external and internal changes, and to publish them as two separate changelog. External changelog should include release notes except those, having "internal" tag. Internal changelog is for the team and should include all release notes.

Is it possible to do with "releases"?

bitprophet commented 8 years ago

@svetlyak40wt Huh, interesting use case. I don't think that's currently possible, but as the internals start to get more OO & more "multi-mode" friendly (as I work on #19 and eventually #50) it wouldn't surprise me if it becomes possible to e.g. subclass a class or two to alter or add behavior.