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

3.x: drop CHANGES.md #5646

Closed
akarnokd opened this issue Oct 5, 2017 · 2 comments
Closed

3.x: drop CHANGES.md #5646

akarnokd opened this issue Oct 5, 2017 · 2 comments

Comments

@akarnokd
Copy link
Member

akarnokd commented Oct 5, 2017

It has become somewhat of an inconvenience to update CHANGES.md before pasting in the release text into the GitHub's own release page, causing a full build before the release build just for that single file.

I don't remember exactly why CHANGES.md was introduced but my assumption is that searching inside it via CTRL+F is simpler than searching within the Releases tab.

Options:

  • Keep it.
  • Drop it.
  • Use a dedicated wiki page instead.
@artem-zinnatullin
Copy link
Contributor

Yis! Keeping changelog file under version control always feelt wrong, releasing and versioning is much easier when it's decoupled from regular code history, branching and PRs routine.

Sometime ago we've decided to just put a giant link to Releases page in changelog files.

I only see few non-major benefits of keeping changelog under version control:

  1. Someone can submit a PR fixing small typos/etc, but then they have to be repeated for releases page
  2. If for some reason we'll need to migrate git hosting to lets say GitLab, migrating releases page will be a manual work
  3. Releases could potentially be lost in case of GitHub failure
  4. Offline access

All of them except №1 could be somewhat solved by duplicating changelog in version tag message.


So I'd propose to only leave a link in the changelog file that'll point to Releases page and maintain changelog on releases page (and optionally in git tag messages).

@akarnokd
Copy link
Member Author

Closing via #6533.

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

No branches or pull requests

2 participants