Skip to content

A way to add release summaries #582

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.

Sign up for GitHub

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

Jump to bottom
Closed
alexjfisher opened this issue Oct 25, 2017 · 7 comments · Fixed by #654
Closed

A way to add release summaries #582

alexjfisher opened this issue Oct 25, 2017 · 7 comments · Fixed by #654
Labels
enhancement

Comments

@alexjfisher
Copy link
Contributor

Hi

It'd be really nice if there was a way to add release 'summaries' when using this tool. Random example.

At first I thought the tool could either examine tags for annotations or maybe query the github 'release' data, but this won't work (people need to generate the changelog and include it in a release before they've tagged the project).

Maybe we could use a .github-changelog-generator.yaml (naming things is hard!) at the root of the repo? I dunno... something along the lines of... (ill thought out example follows)

---
releases:
  'v1.0.1':
    summary: 'This is a small bug fix release only affected Arch Linux users.'
  'v1.0.0':
    summary: 'This release adds support for internationalization.'

Any suggestions?
@olleolleolle
Copy link
Collaborator

@alexjfisher Perhaps a .github-changelog-generator/ directory?

@alexjfisher
Copy link
Contributor Author

With a file of markdown for each tag you want a summary?

@olleolleolle
Copy link
Collaborator

olleolleolle commented Oct 25, 2017 •
edited
Loading

@alexjfisher I was more like;

  • .github-changelog-generator/summaries.yml
  • .github-changelog-generator/config.ini (or whatever we can call the format in the current .github_changelog_generator file)

Now that we're dreaming of things to come.

@alexjfisher
Copy link
Contributor Author

I went for yaml with a separate key for summary with the vague idea of making it more future proof. Pass. Maybe somebody else would be interested in setting exclude: true or something? Probably not.

@alexjfisher
Copy link
Contributor Author

oh ok. That makes sense. Maybe 'releases.yml' to allow for other stuff in the future? I can imagine people maybe wanting to mark a release as 'pulled' or 'deprecated' or who knows. At Vox Pupuli we might try and use the same data to mark tags in github as releases. Maybe something that aligns with that concept would be good?

@olleolleolle
Copy link
Collaborator

  • .github-changelog-generator/releases.yml then

@skywinder
Copy link
Member

Feel free to reopen the issue, if you still need help. 👍

@hunner hunner mentioned this issue May 1, 2018
Closed
@skywinder skywinder reopened this Aug 18, 2018
@mob-sakai mob-sakai mentioned this issue Aug 18, 2018
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add release summary section
3 participants
@olleolleolle @alexjfisher @skywinder