Skip to content

[DOC] Explain new Labels and Summary Section support in README #678

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

Closed
olleolleolle opened this issue Sep 21, 2018 · 10 comments · Fixed by #679
Closed

[DOC] Explain new Labels and Summary Section support in README #678

olleolleolle opened this issue Sep 21, 2018 · 10 comments · Fixed by #679

Comments

@olleolleolle
Copy link
Collaborator

Update README.md

  • with new labels support and
  • examples of usage of summary section

See #654

@mob-sakai
Copy link
Contributor

As a draft:

Examples of usage of summary section

For each version, you can add a release summary with text, images, gif animation, etc., and show new features and notes clearly to the user.
As an example, add the release summary for v1.0.0 in the following steps:

  1. Create a new issue
  2. Add description as release summary
![image](https://user-images.githubusercontent.com/12690315/45935880-006a8200-bfeb-11e8-958e-ff742ae66b96.png)

Hello, World! :tada:
  1. Set label 'release-summary' and milestone 'v1.0.0'
  2. Close the issue and execute github-changelog-generator
  3. It looks like this:

v1.0.0 (2014-11-07)

Full Changelog

image

Hello, World! 🎉

Implemented enhancements:

  • Add some features

@olleolleolle
Copy link
Collaborator Author

Thanks, this is a good start, would you begin a PR with that content? (I can't copy-and-paste the raw Markdown from here.)

@olleolleolle
Copy link
Collaborator Author

Actually, I can see the raw Markdown!

olleolleolle added a commit that referenced this issue Sep 24, 2018
  - fixes #678 
  - thanks so much for authoring the example, @mob-sakai
@mob-sakai
Copy link
Contributor

Thanks for your PR!

@skywinder
Copy link
Member

You're awesome, guys! 🎉

@edusantana
Copy link
Contributor

edusantana commented Jan 17, 2019

I was trying to use it, but it is not working. Can you share a project that uses it?

abntex/limarka#171 - this issue doest't generate it.

The changelog without the summary:

# Change Log

## [v1.0.2](https://github.com/abntex/limarka/tree/v1.0.2) (2019-01-17)
[Full Changelog](https://github.com/abntex/limarka/compare/v1.0.1...v1.0.2)

**Melhorias implementadas:**

- Utilizar o tinytex nos testes automatizados [\#164](https://github.com/abntex/limarka/issues/164)

**Issues fechados:**

- Atualizar documentação sobre o pacote pdftk no Ubuntu 18.04 [\#168](https://github.com/abntex/limarka/issues/168)
- Atualizar documentação sobre dependências de compilação no Ubuntu 17.10.1 [\#160](https://github.com/abntex/limarka/issues/160)
- Sumário da versão v1.0.2 [\#171](https://github.com/abntex/limarka/issues/171)
- Atualizar documentação sobre o TinyTex [\#170](https://github.com/abntex/limarka/issues/170)

@edusantana
Copy link
Contributor

@mob-sakai
Copy link
Contributor

Hi @edusantana
Did you install github-changelog-generator with gem install?
It is a too old version to use summary section.

$ github_changelog_generator  -v
Version: 1.14.3

Use gem specific_install instead of gem install.

gem specific_install git@github.com:github-changelog-generator/github-changelog-generator.git -b master

@edusantana
Copy link
Contributor

As you see here a use it like this:

Gem::Specification.new do |spec|
  #...
  spec.add_development_dependency "github_changelog_generator"
  #...
end

My workaround was to use it at the Gemfile as well, but I don't like it.

At what version this summary option was added?

@mob-sakai
Copy link
Contributor

1.15.0, but it has not been released yet.

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 a pull request may close this issue.

4 participants