Skip to content

streamingfast/firehose-near

Repository files navigation

NEAR on StreamingFast

reference License

Usage

Release

  1. Define the version information that we are about to release:

    version=1.0.0 # Use correct version, latest released is given by 'git describe --tags --abbrev=0'

    Note Those instructions uses sd, brew install sd (or see sd)

  2. Prepare the release by updating the CHANGELOG.md file, updating ## Unreleased title:

    sd "## Unreleased" "## [$version](https://github.com/streamingfast/firehose-near/releases/tag/v$version)" CHANGELOG.md
  3. Update substreams.yaml version: v1.0.0 to version: v1.0.1:

    sd "version: v.*" "version: v$version" substreams/substreams.yaml
  4. Commit to prepare release:

    git add CHANGELOG.md substreams/substreams.yaml
    git commit -m "Preparing for release v$version"
  5. Run the ./bin/release.sh Bash script to perform a new release. It will ask you questions as well as driving all the required commands, performing the necessary operation automatically. The Bash script publishes a GitHub release by default, so you can check first that everything is all right.

    ./bin/release.sh v$version

One-Liner

version=1.0.0 # Use correct version, latest released is given by 'git describe --tags --abbrev=0'

sd "## Unreleased" "## [$version](https://github.com/streamingfast/firehose-near/releases/tag/v$version)" CHANGELOG.md &&\
sd "version: v.*" "version: v$version" substreams.yaml &&\
git add CHANGELOG.md substreams.yaml &&\
git commit -m "Preparing for release v$version" &&\
./bin/release.sh v$version

Contributing

Issues and PR in this repo related strictly to the NEAR on StreamingFast.

Report any protocol-specific issues in their respective repositories

Please first refer to the general StreamingFast contribution guide, if you wish to contribute to this code base.

This codebase uses unit tests extensively, please write and run tests.

License

Apache 2.0