feat: revisioning info moved to its own file

[fahad19]

Background

Featurevisor's build system relied on the version found in package.json for the generated datafiles' revision property.

Links for further understanding:

• https://featurevisor.com/docs/building-datafiles/
• https://featurevisor.com/docs/state-files/
• https://featurevisor.com/docs/deployment/
• https://featurevisor.com/docs/integrations/github-actions/

Challenges

For every new successful build, it meant incrementing the version number as found in package.json.

Many npm projects rely on caching their dependencies, and the cache is busted if the hash of package.json and/or package-lock.json changes.

If we keep updating the version in package.json for every build, this way of caching becomes redundant. We don't want that.

Solution

Now the revision info is stored next to state files in .featurevisor/REVISION file.

This will contain a numeric value, which will be incremented by every build.

And package.json remains untouched and unused going forward, leaving you with the choice to adopt a caching strategy for your npm dependencies the way you want.

Backwards compatibility

Those who have been following our deployment guide with GitHub Actions and/or Cloudflare Pages before, it will maintain backwards compatibility by:

• taking the last known version from package.json
• using that as a base and create a new .featurevisor/REVISION file
• and use the new file going forward

How to upgrade?

If you have been following our deployment guidelines, then it's really nothing more than a version upgrade for @featurevisor/cli for you.

But you may want to tweak your pipeline (like GitHub Actions workflows) to benefit from this change.

TODOs

• Update docs
• Update CI/CD example in https://github.com/featurevisor/featurevisor-example-cloudflare