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 a HISTORY file for tracking version changes #100

Closed
isaac-io opened this issue Aug 2, 2022 · 1 comment · Fixed by #189
Closed

Add a HISTORY file for tracking version changes #100

isaac-io opened this issue Aug 2, 2022 · 1 comment · Fixed by #189
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Milestone

Comments

@isaac-io
Copy link
Contributor

isaac-io commented Aug 2, 2022

RocksDB has a HISTORY.md file, where changes between releases are tracked.

We need to have our own change log file (because our versions are different, and because future rebases will mess up the history).

Rename the RocksDB HISTORY.md file to HISTORY_ROCKSDB.md and add a new HISTORY.md file that we'll use to track our change log in. We probably want to use a similar format (we also want to mention the base RocksDB version for each release, at least for the time being).

@isaac-io isaac-io added enhancement New feature or request documentation Improvements or additions to documentation labels Aug 2, 2022
isaac-io added a commit that referenced this issue Aug 30, 2022
Since we have our own changes, it doesn't make much sense to continue
using the RocksDB file. We would like to have our own tracking of changes
in Speedb in a separate file, so this change renames the RocksDB file in
preparation for creating our own file.
isaac-io added a commit that referenced this issue Aug 30, 2022
Add a change log file in the same format as the RocksDB one to track changes
between released versions. Currently this contains an abbreviated change
log for version 2.0.0, but not any of the changes that landed since then.
@isaac-io isaac-io linked a pull request Aug 30, 2022 that will close this issue
isaac-io added a commit that referenced this issue Aug 30, 2022
Since we have our own changes, it doesn't make much sense to continue
using the RocksDB file. We would like to have our own tracking of changes
in Speedb in a separate file, so this change renames the RocksDB file in
preparation for creating our own file.
isaac-io added a commit that referenced this issue Aug 30, 2022
Add a change log file in the same format as the RocksDB one to track changes
between released versions. Currently this contains an abbreviated change
log for version 2.0.0, but not any of the changes that landed since then.
@Guyme
Copy link

Guyme commented Sep 11, 2022

@rtpro @bosmatt - Please review.

@isaac-io isaac-io added this to the v2.1.0 milestone Sep 21, 2022
@bosmatt bosmatt linked a pull request Oct 2, 2022 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
4 participants