added RELEASE.md file with developer release instructions. reset chan…

…gelog

CHANGELOG.md

@@ -1,7 +1 @@
-## 1.25.0-rc.1-dm
 
-* Merged `neard` version `1.25.0-rc.1`.
-
-## 1.24.0-dm
-
-* Merged `neard` version `1.24.0`.

RELEASE.md

@@ -0,0 +1,23 @@
+## Developer Release Guide
+
+When a new version of nearcore is released, the near-firehose-indexer should be updated to use the latest version of nearcore. This is done by updating the `Cargo.toml` file to point to the new version of nearcore.
+
+Once this is done, compile the project locally using `make release` and check that the project compiles locally.  This is important, because the Github action takes about 30 minutes to compile, and so compiling locally allows you to potentially save a lot of time.
+
+After you have validated that the project compiles locally, tag your commit with the following format: `{{nearcore-tag}}-fire`.
+
+The Github action will then compile the project and push the docker image to Dockerhub.  This image can then be used in the `firehose-near` project's Github action to build the bundle image.
+
+### Example:
+
+Let's say Near releases a new version of nearcore with tag `1.99.0-rc.3`
+1. Update the `Cargo.toml` file package version to `1.99.0-rc.3`
+2. In `Cargo.toml`, update all `nearcore` dependencies' `rev` tag to `1.99.0-rc.3`
+3. Run `make release` locally to validate that the project compiles
+4. Commit changes and tag commit with `1.99.0-rc.3-fire`
+5. Push commit.
+
+### Notes
+
+* When nearcore releases a new set of release candidates (ie: an `-rc.1` release), this usually involves many more changes than a normal release. Normally, you will need to also update the `rust-toolchain.toml` file to match their version.  
+* If compilation still fails, then you will need to dig deeper into the reasons why. Start with the compilaton errors and work backwards from there.  One thing you might try is to git checkout the original nearcore project at the given tag, and try to compile their project.