Use h2 for version headings in Changelog to allow deeplinking #5149
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
I didn't want to be too intrusive on this one. I love the project and had a need for deeplinking the release notes for 1.4, so that is how this one came about. Some further changes to the changelog I would suggest, based upon my experience with my somewhat popular ruby code coverage library simplecov:
I have used this for the latest release of simplecov and it corresponds to the github tags api so it'd be very easy to scrape and use in unforeseen ways :) Thanks for the great work on this. |
mpdehaan
added a commit
that referenced
this pull request
Dec 4, 2013
Use h2 for version headings in Changelog to allow deeplinking
|
merged, thanks! |
dagwieers
added a commit
to dagwieers/ansible
that referenced
this pull request
Dec 7, 2016
Various changes and improvements: - Fixed a few issues with the existing unzip support which were related to Zipfile (which is fundamentally incompatible with unzip excludes/opts). And issues related to forced ownership. - Improvements to the UnarchiveError Exception, so it can report more detailed information to why an archive cannot be handled. - A bugfix relatd to unicode filenames and crc32 handling. - Renamed a few things so the code is easier to read. - Ensure gtar considers size changes to unarchive its content. This fixes ansible#5149. - Added a note about ZIP archives without directories This fixes ansible#5744. The unarchive module is a hard beast to tame, corner-cases and platform-specific issues make it hard to troubleshoot individual issues. - Improves the default output (e.g. unzip no longer shows standard output, just like gtar) and adds the ability to get debug-output when using -vvvv (verbosity >= 4) or -vvvvv. So that when issues are i reported we have the means to look what is going on internally. - Because the output by default is reduced, proper warnings/errors are now more obvious to end-users, e.g. ``` TASK [unarchive] *************************************************************** task path: /home/dag/home-made/ansible.testing/test126.yml:11 changed: [localhost] => {"changed": true, "dest": "/tmp/test126a", "extract_results": {"cmd": ["/usr/bin/unzip", "-q", "-o", "/home/dag/.ansible/tmp/ansible-tmp-1479989967.66-3171393713112/source", "-x", "some.directory/", "another.directory/simple.test.file.txt", "-d", "/tmp/test126a"], "err": "caution: excluded filename not matched: some.directory/\ncaution: excluded filename not matched: another.directory/simple.test.file.txt\n", "out": "", "rc": 0}, "gid": 500, "group": "dag", "handler": "ZipArchive", "mode": "0775", "owner": "dag", "secontext": "unconfined_u:object_r:user_tmp_t:s0", "size": 4096, "src": "/home/dag/.ansible/tmp/ansible-tmp-1479989967.66-3171393713112/source", "state": "directory", "uid": 500} ``` Whereas before the complete list of deflated files was being shown (when using -v) which was much more than anyone was willing to look at.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Amended the changelog to use Markdown-style h2 headings for the versions. This allows deeplinking release notes for specific versions thanks to html-pipeline. Yay :)