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

Add CHANGELOG and detailed migration notes to docs/meta/changelog #76

Closed
12 tasks done
numberoverzero opened this issue Nov 7, 2016 · 4 comments
Closed
12 tasks done
Assignees
Labels
Milestone

Comments

@numberoverzero
Copy link
Owner

numberoverzero commented Nov 7, 2016

Blocks #75, once those docs are merged, the default docs page for Bloop will describe a 1.0.0 which is significantly different from 0.9.x.

To complete:

@numberoverzero numberoverzero added this to the 1.0 milestone Nov 7, 2016
@numberoverzero numberoverzero self-assigned this Nov 7, 2016
@numberoverzero numberoverzero added docs and removed api labels Nov 7, 2016
@numberoverzero
Copy link
Owner Author

Commits for each version's release. Next step: git diff 0.9.x 0.9.x+1 for x [0, 12]

@numberoverzero
Copy link
Owner Author

numberoverzero commented Nov 10, 2016

Headings from Keep a Changelog, always in this order:

  • [Added] for new features.
  • [Changed] for changes in existing functionality.
  • [Deprecated] for once-stable features removed in upcoming releases.
  • [Removed] for deprecated features removed in this release.
  • [Fixed] for any bug fixes.
  • [Security] to invite users to upgrade in case of vulnerabilities.

Sample changelog

@numberoverzero
Copy link
Owner Author

git diff v0.9.0..v0.9.1 had no public changes. Dropping 0.9.0 from the changelog since the upgrade instructions will be the same as 0.9.1.

@numberoverzero
Copy link
Owner Author

$ git log v0.9.13..docs-rewrite-03 --oneline | wc -l
560

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

No branches or pull requests

1 participant