Skip to content

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Optionally Print Issue and Pull Requests Body #616

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

Merged

Conversation

ArtieReus
Copy link
Contributor

This commit adds the possibility by configuration to enhance the issues and pull requests lines printed in the changelog with the first paragraph of body. Empty bodies will be ignore so that the default behaviour stays as it is.

The here proposed enhancement would look like this:

Fixed bugs:

  • Error when trying to generate log for repo without tags #32
    This is the body of the issue. It will just copy the first paragraph of the body.

Merged pull requests:

  • PrettyPrint class is included using lowercase 'pp' #43 (schwing)
    This is the body of the pull request. It will just copy the first paragraph of the body.

Having this pull request as an example this will be the difference adding "issue_line_body" in your configuration:

  • Optionally Print Issue and Pull Requests Body #XX (ArtieReus)

  • Optionally Print Issue and Pull Requests Body #XX (ArtieReus)
    This commit adds the possibility by configuration to enhance the issues and pull requests lines printed in the changelog with the first paragraph of body. Empty bodies will be ignore so that the default behaviour stays as it is.

@olleolleolle
Copy link
Collaborator

(This change is one of those that would be much simpler to do when we have custom templates instead - so that the user would pick what to output themselves, using that.)

ArtieReus added a commit to sapcc/kubernikus that referenced this pull request Jan 29, 2018
Changelog docker file updated to use a fork with the pull request „Optionally Print Issue and Pull Requests Body“ (github-changelog-generator/github-changelog-generator#616) which is not yet merged in the original repo.
ArtieReus added a commit to sapcc/elektra that referenced this pull request Jan 29, 2018
Changelog docker file updated to use a fork with the pull request „Optionally Print Issue and Pull Requests Body“ (github-changelog-generator/github-changelog-generator#616) which is not yet merged in the original repo.
@lindydonna
Copy link

@ArtieReus Looking forward to this being merged in--I was about to code up the feature myself. :)

@ArtieReus
Copy link
Contributor Author

@lindydonna still waiting for any action over 1 month. If you want to use it before it gets merged you can get it from my fork: https://github.com/ArtieReus/github-changelog-generator/tree/include_body_issue
It looks pretty nice, see changelog in one of my projects: https://github.com/sapcc/elektra/blob/master/CHANGELOG.md

@lindydonna
Copy link

@ArtieReus I tried to use it from your fork, but I'm running into strange problems with master trying to run on MacOS. Any ideas on #629?

I ended up backporting your change to 1.4.3, but it's a horrible hack!

Copy link
Member

@skywinder skywinder left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for your contribution. Seems, that its feature is really helpful and hight demanded, according likes :)

Here is some notes above. With small additions.

Then I would like to listen what other maintainers think about this PR.

@@ -43,27 +45,28 @@ def default_sections
project: "repo",
bug_labels: ["bug"],
enhancement_labels: ["enhancement"],
breaking_labels: ["breaking"]
breaking_labels: ["breaking"],
issue_line_body: true
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Everything is looking good. Just would like to leave default behavior as is, without a body by default.

@@ -43,27 +45,28 @@ def default_sections
project: "repo",
bug_labels: ["bug"],
enhancement_labels: ["enhancement"],
breaking_labels: ["breaking"]
breaking_labels: ["breaking"],
issue_line_body: true
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. please, add relevant option there:

@ArtieReus
Copy link
Contributor Author

Happy to hear that. Applied changes.

@ArtieReus
Copy link
Contributor Author

ArtieReus commented Apr 25, 2018

Anything new on this PR?

@skywinder
Copy link
Member

Thanks, @ArtieReus
Let's wait for the final decision of @olleolleolle , since he is a captain of that project for now 😉

Copy link
Collaborator

@olleolleolle olleolleolle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Make this change!

The control structures are made in the style of the existing code, and the comments are helpful.

@ferrarimarco
Copy link
Contributor

ferrarimarco commented Apr 27, 2018

Thanks @ArtieReus
Can you also rebase against the latest master, so we can merge without conflicts?

@ArtieReus
Copy link
Contributor Author

Merged master into the branch. Notice that I changed
Time.new(2017, 12, 4, 12).utc
to
Time.new(2017, 12, 4, 12, 0, 0, "+00:00").utc
in
spec/unit/generator/entry_spec.rb
just because in my time zone I was getting a different date.

Thx

@ferrarimarco
Copy link
Contributor

Instead of merging new commits can you please just rebase you work on master? Thanks

@ArtieReus ArtieReus force-pushed the include_body_issue branch from 476871a to 882ee0c Compare April 27, 2018 11:45
@ArtieReus
Copy link
Contributor Author

Done!

@olleolleolle
Copy link
Collaborator

I'll take this into master, now.

@olleolleolle olleolleolle merged commit a17b793 into github-changelog-generator:master Apr 27, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants
Morty Proxy This is a proxified and sanitized view of the page, visit original site.