Tag releases with semantic versioning?

bestinslot-xyz / OPI

Open Protocol Indexer, OPI, is the best-in-slot open-source indexing client for meta-protocols on Bitcoin.

Apache License 2.0

202 stars 110 forks source link

Tag releases with semantic versioning? #8

Closed t4t5 closed 9 months ago

t4t5 commented 9 months ago

It would be nice to have official tagged releases so that users of the library know when breaking changes have been introduced that require rebuilding the database.

Otherwise you might pull the latest changes expecting some minor bug fixes only to be forced to roll all your data back 😬

samedcildir commented 9 months ago

Noted 👍 We'll definitely add releases, also we're trying to make rebuild as unnecessary as possible but we've found a bug which would affect sns indexing which will be introduced shortly, so we've decided to push the fix as soon as possible.

We will announce breaking changes in releases from now on.

samedcildir commented 9 months ago

I've added a new release tag (v0.3.0) for final commit. Normally in semantic versioning, a Minor version change is backwards compatible, however currently we're not ready for v1.0.0 so I've used minor version update for reindex necessary changes (just like ordinals/ord)