-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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.
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
The tool #51
Comments
On the subject of filtering |
One thing that might be nice is if the tool supported building annotated git tags based on the changelog. So, if we use this project's changelog as an example, it could take this: # Change Log
All notable changes to this project will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/).
## [Unreleased][unreleased]
## [0.0.7] - 2015-02-16
### Added
- Link, and make it obvious that date format is ISO 8601
### Changed
- Clarified the section on "Is there a standard change log format?"
### Fixed
- Fix Markdown links to tag comparison URL with footnote-style links.
## [0.0.6] - 2014-12-12
### Added
- README section on "yanked" releases.
[snip] and create an annotated git tag
I have a Ruby script that does this for a different changelog format that I could modify slightly to work with the convention here. |
@elyscape Good idea although using this project as an example remember that annotated git tag messages work very much like commits so it's best to keep the first line as a condensed summary of the release and not a repeat of the information already encoded in the tag itself ( Expand the Assuming the git tags were properly created on the actual release date of the version or backdated using the git committer date variable ( |
My script does backdate to the time of the tagged commit, but I could also modify it to also prompt for a version name so it would output something like:
|
@elyscape I couldn't remember why I didn't put the categories from the release in the git tag yesterday, and then today I remembered why:
A You will then have to remember to remove the default comment that git adds (which remain prepended with a Looks good when done right though: The only issue at this point is that the Markdown heading level is now improper (heading 3) if there is no heading 1 and heading 2 to accompany it, so that should probably change. |
That's all pretty simple to handle inside a script. As for the default comment, my script writes the tag message to a file and then feeds it to git with
Does that matter much, though? I'm not aware of a requirement that H3s be preceded by H2s and/or H1s. |
For the people interested, we've been working on a tool regarding changelogs the past couple months (based on this spec) It is still in beta but would love to hear your thoughts on it: The marketing bit is still being worked on. But it first of all parses Github releases, and secondly it parses pull requests descriptions following the keepachangelog.com format to generate the unreleased changelog notes. Also I'm aware it doesn't read a |
It seems that it is now in public beta and the new URL is http://changehub.io/. @bramdevries Signing up doesn't work as there is a 404 when pushing "Keep me updated". |
@elyscape I wish I had read this:
before I wrote https://github.com/ianfixes/keepachangelog_manager_gem It does the thing you suggest, although for the changelog file itself. |
There were already some suggestions about a "tool".
I think they should be concentrated in one issue concerning the tool specifically.
What should it do?
I can cook something up in Python, but as this is not my own project, I don't want to impose my preferences on anyone :)
However this tool should be part of this project, something like Syncthing - they also have reference implementation for their protocol, and it seems like a good idea.
The text was updated successfully, but these errors were encountered: