Skip to content

Commit

Permalink
Updated instructions for new releases
Browse files Browse the repository at this point in the history
  • Loading branch information
Olshansk committed Apr 9, 2024
1 parent 6b29599 commit e693a6c
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 12 deletions.
16 changes: 8 additions & 8 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -99,16 +99,16 @@ benchmark_proof_sizes: ## runs the benchmarks test the proof sizes for differen
# Delete tag locally: git tag -d v1.2.3
# Delete tag remotely: git push --delete origin v1.2.3

.PHONY: tag_minor_release
tag_minor_release: ## Tag a new minor release (e.g. v1.0.0 -> v1.1.0)
@$(eval LATEST_TAG=$(shell git describe --tags `git rev-list --tags --max-count=1`))
@$(eval NEW_TAG=$(shell echo $(LATEST_TAG) | awk -F. '{$$2 += 1; $$3 = 2; print $$1 "." $$2 "." $$3}'))
@git tag $(NEW_TAG)
@echo "New minor release version: $(NEW_TAG)\nRun \"git push origin $(NEW_TAG)\" and draft a new release at https://github.com/pokt-network/smt/releases/new"

.PHONY: tag_bug_fix
tag_bug_fix: ## Tag a new bug fix release (e.g. v1.0.1 -> v1.0.2)
@$(eval LATEST_TAG=$(shell git describe --tags `git rev-list --tags --max-count=1`))
@$(eval NEW_TAG=$(shell echo $(LATEST_TAG) | awk -F. '{$$3 += 1; print $$1 "." $$2 "." $$3}'))
@git tag $(NEW_TAG)
@echo "New bug fix version: $(NEW_TAG)\nRun \"git push origin $(NEW_TAG)\" and draft a new release at https://github.com/pokt-network/smt/releases/new"
@echo "New bug fix version: $(NEW_TAG)\nRun:\tgit push origin $(NEW_TAG)\nAnd draft a new release at https://github.com/pokt-network/smt/releases/new"

.PHONY: tag_minor_release
tag_minor_release: ## Tag a new minor release (e.g. v1.0.0 -> v1.1.0)
@$(eval LATEST_TAG=$(shell git describe --tags `git rev-list --tags --max-count=1`))
@$(eval NEW_TAG=$(shell echo $(LATEST_TAG) | awk -F. '{$$2 += 1; $$3 = 2; print $$1 "." $$2 "." $$3}'))
@git tag $(NEW_TAG)
@echo "New minor release version: $(NEW_TAG)\nRun:\tgit push origin $(NEW_TAG)\nAnd draft a new release at https://github.com/pokt-network/smt/releases/new"
40 changes: 36 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,14 @@

<!-- toc -->

- [Overview](#overview)
- [Documentation](#documentation)
- [Tests](#tests)
- [Benchmarks](#benchmarks)
- [smt](#smt)
- [Overview](#overview)
- [Documentation](#documentation)
- [Tests](#tests)
- [Benchmarks](#benchmarks)
- [Release Tags](#release-tags)
- [Tagging a new release](#tagging-a-new-release)
- [Push and Release](#push-and-release)

<!-- tocstop -->

Expand Down Expand Up @@ -60,3 +64,31 @@ To view pre-ran results of the entire benchmarking suite see

[jmt whitepaper]: https://developers.diem.com/papers/jellyfish-merkle-tree/2021-01-14.pdf
[libra whitepaper]: https://diem-developers-components.netlify.app/papers/the-diem-blockchain/2020-05-26.pdf

## Release Tags

You can tag and publish a new release by following the instructions bellow.

### Tagging a new release

For a bug fix:

```bash
make tag_bug_fix
```

For a minor release run:

```bash
make tag_minor_release
```

### Push and Release

Then, push the tag to the repository:

```bash
git push origin v<release>
```

Create a release on GitHub with the tag and the release notes [here](https://github.com/pokt-network/smt/releases/new).

0 comments on commit e693a6c

Please sign in to comment.