Initial release v0.1 (#308)

- Add CHANGELOG and update with initial version
- Add contributors README
- Add release doc
This commit is contained in:
Oskar Thorén 2020-11-30 11:38:51 +08:00 committed by GitHub
parent dc3b3b87be
commit 08f1c62924
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 68 additions and 0 deletions

18
CHANGELOG.md Normal file
View File

@ -0,0 +1,18 @@
# Changelog
## 2020-11-30 v0.1
Initial beta release.
This release contains:
- A Nim implementation of the [Waku v1 protocol](https://specs.vac.dev/waku/waku.html).
- A Nim implementation of the [Waku v2 protocol](https://specs.vac.dev/specs/waku/v2/waku-v2.html).
- CLI applications `wakunode` and `wakunode2` that allows you to run a Waku v1 or v2 node.
- Examples of Waku v1 and v2 usage.
- Various tests of above.
Currenty the Waku v2 implementation, and [most protocols it consist of](https://specs.vac.dev/specs/waku/),
are in a draft/beta state. The Waku v1 implementation is stable but not under active development.
Feedback welcome!

View File

@ -0,0 +1,9 @@
# Contributors
This folder contains documentation that is primarily useful for contributors. Some links and
resources here might require privileged access.
Example resources:
- How to do releases
- Viewing and modifying metrics dashboard

View File

@ -0,0 +1,41 @@
# Release Process
How to do releases.
For more context, see https://trunkbaseddevelopment.com/branch-for-release/
## How to to do releases
1. Checkout a release branch from master
`git checkout -b release/v0.1`
2. Update `CHANGELOG.md` and ensure it is up to date
3. Create a tag with the same name as release and push it
```
git tag -as v0.1 -m "Initial release."
git push origin v0.1
```
4. Open a PR
5. Harden release in release branch
6. Modify tag
If you need to update stuff, remove tag and make sure the new tag is associated
with CHANGELOG update.
```
# Delete tag
git tag -d v0.1
git push --delete origin v0.1
# Make changes, rebase and tag again
# Squash to one commit and make a nice commit message
git rebase -i origin/master
git tag -as v0.1 -m "Initial release."
git push origin v0.1
```