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

Show multiple issue links in CHANGELOG entries #2620

Merged
merged 1 commit into from Jul 26, 2017

Conversation

Projects
None yet
4 participants
@mihaic
Contributor

mihaic commented Jul 26, 2017

Restores the functionality removed in PR #2488.

  • Add a new news fragment into the changelog folder
    • name it $issue_id.$type for example (588.bug)
    • if you don't have an issue_id change it to the pr id after creating the pr
    • ensure type is one of removal, feature, bugfix, vendor, doc or trivial
    • Make sure to use full sentences with correct case and punctuation, for example: "Fix issue with non-ascii contents in doctest text files."
  • Target: for bugfix, vendor, doc or trivial fixes, target master; for removals or features target features;
  • Make sure to include reasonable tests for your change if necessary

Unless your change is a trivial or a documentation fix (e.g., a typo or reword of a small section) please:

  • Add yourself to AUTHORS;
Show multiple issue links in CHANGELOG entries
Restores the functionality removed in PR #2488.
@nicoddemus

Thanks!

I removed it because I didn't see much value in it and it complicates the template a bit. Can you describe some cases where this is useful?

I'm not opposed to accept this, I'm just curious. 👍

@mihaic

This comment has been minimized.

Contributor

mihaic commented Jul 26, 2017

I had not realized you removed it on purpose. It seems useful when a feature is added via multiple PRs or when a bug is not completely fixed by an issue and a second issue is created for a corner case, all within the same release cycle.

@coveralls

This comment has been minimized.

coveralls commented Jul 26, 2017

Coverage Status

Coverage remained the same at 92.059% when pulling 10ded39 on mihaic:multiple-issues-in-changelog into dd294aa on pytest-dev:master.

@nicoddemus

This comment has been minimized.

Member

nicoddemus commented Jul 26, 2017

It seems useful when a feature is added via multiple PRs or when a bug is not completely fixed by an issue and a second issue is created for a corner case, all within the same release cycle.

I see, just thought the mechanism to group them was a little brittle, which is to have the exact same text for it; seems easy to inadvertently fix a typo or something and make the issue appear in separate entries because of that.

As I said I don't oppose adding it back though if others think this is useful. 👍

@RonnyPfannschmidt RonnyPfannschmidt requested a review from nicoddemus Jul 26, 2017

@RonnyPfannschmidt

looks good 👍

@nicoddemus

This comment has been minimized.

Member

nicoddemus commented Jul 26, 2017

Just tried the PR, here's the resulting changelog: https://gist.github.com/nicoddemus/fb844dade0c4b14a1fd49b5cdb00d6ce

Thanks again @mihaic

@nicoddemus nicoddemus merged commit 1a9bc14 into pytest-dev:master Jul 26, 2017

1 of 2 checks passed

continuous-integration/appveyor/pr Waiting for AppVeyor build to complete
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

@mihaic mihaic deleted the mihaic:multiple-issues-in-changelog branch Jul 26, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment