Skip to content
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

ditch CHANGELOG.md in favor of github releases #136

Closed
ahmadnassri opened this issue Apr 14, 2015 · 6 comments
Closed

ditch CHANGELOG.md in favor of github releases #136

ahmadnassri opened this issue Apr 14, 2015 · 6 comments

Comments

@ahmadnassri
Copy link
Contributor

maintaining a single markdown file will get lengthy and harder as you add more releases.

Github Releases, not only shows the appropriate release names / tag / assets, but is also Markdown powered, so you end up with a better "change log" that's also paginated, with direct links to versioned tag + release assets.

@thibaultcha
Copy link
Member

I prefer a change log.

@ahmadnassri
Copy link
Contributor Author

can we at least update the release description in Github Releases with meaningful info?

@ahmadnassri ahmadnassri reopened this Apr 14, 2015
@thibaultcha
Copy link
Member

you can do it if you want but I think it'll be useless.

A changelog is:

  • more flexible
  • less relying on github
  • easier to search in
  • part of the git history

From there, I see no reason to write things in releases or to duplicate information between the two. Except for a link to the changelog section.

@nijikokun
Copy link
Contributor

Generally projects do both, so, in the famous words of zoidberg, "why not both?"

By doing releases, you add your changelog message there, which you can then copy it over to changelog.md. Or vice versa.

@ahmadnassri
Copy link
Contributor Author

thinking of github releases as simple/unified way that we can always rely on finding the info across all our projects, oss or not, regardless of the source (CHANGELOG.md, JIRA, git history)

give us a consistent way to find the info across many projects rather than remembering different wikis / source control.

plus its API accessible, so that's neat

@thibaultcha thibaultcha removed their assignment Apr 15, 2015
@thibaultcha
Copy link
Member

We'll update release notes. let's stop nitpicking

hutchic pushed a commit that referenced this issue Jun 10, 2022
### Summary

#### libyaml 0.2.2 release

- #95 -- build: do not install config.h
- #97 -- appveyor.yml: fix Release build
- #103 -- Remove unused code in yaml_document_delete
- #104 -- Allow colons in plain scalars inside flow collections
- #109 -- Fix comparison in tests/run-emitter.c
- #117 -- Fix typo error
- #119 -- The closing single quote needs to be indented...
- #121 -- fix token name typos in comments
- #122 -- Revert removing of open_ended after top level plain scalar
- #125 -- Cherry-picks from PR 27
- #135 -- Windows/C89 compatibility
- #136 -- allow override of Windows static lib name

#### libyaml 0.2.3 release

- #130 Fixed typo.
- #144 Fix typo in comment
- #140 Use pointer to const for strings that aren't/shouldn't be modified
- #128 Squash a couple of warnings in example-deconstructor-alt
- #151 Fix spelling for error message
- #161 Make appveyor config be a hidden file
- #159 Add CHANGES file
- #160 Always output document end before directive (YAML 1.2 compatibility)
- #162 Output document end marker after open ended scalars
- #157 change cmake target name from libOFF.a to libyaml.a
- #155 include/yaml.h: fix comments
- #169 Fixed missing token in example
- #127 Avoid recursion in the document loader.
- #172 Support %YAML 1.2 directives
- #66 Change dllexport controlling macro to use _WIN32
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

No branches or pull requests

3 participants