Skip to content

Commit 3556189

Browse files
committed
Initial release v0.1
- Add CHANGELOG and update with initial version - Add contributors README - Add release doc
1 parent f3b6489 commit 3556189

File tree

3 files changed

+68
-0
lines changed

3 files changed

+68
-0
lines changed

CHANGELOG.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Changelog
2+
3+
## 2020-11-30 v0.1
4+
5+
Initial beta release.
6+
7+
This release contains:
8+
9+
- A Nim implementation of the [Waku v1 protocol](https://specs.vac.dev/waku/waku.html).
10+
- A Nim implementation of the [Waku v2 protocol](https://specs.vac.dev/specs/waku/v2/waku-v2.html).
11+
- CLI applications `wakunode` and `wakunode2` that allows you to run a Waku v1 or v2 node.
12+
- Examples of Waku v1 and v2 usage.
13+
- Various tests of above.
14+
15+
Currenty the Waku v2 implementation, and [most protocols it consist of](https://specs.vac.dev/specs/waku/),
16+
are in a draft/beta state. The Waku v1 implementation is stable but not under active development.
17+
18+
Feedback welcome!

docs/contributors/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Contributors
2+
3+
This folder contains documentation that is primarily useful for contributors. Some links and
4+
resources here might require privileged access.
5+
6+
Example resources:
7+
8+
- How to do releases
9+
- Viewing and modifying metrics dashboard
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Release Process
2+
3+
How to do releases.
4+
5+
For more context, see https://trunkbaseddevelopment.com/branch-for-release/
6+
7+
## How to to do releases
8+
9+
1. Checkout a release branch from master
10+
11+
`git checkout -b release/v0.1`
12+
13+
2. Update `CHANGELOG.md` and ensure it is up to date
14+
15+
3. Create a tag with the same name as release and push it
16+
17+
```
18+
git tag -as v0.1 -m "Initial release."
19+
git push origin v0.1
20+
```
21+
22+
4. Open a PR
23+
24+
5. Harden release in release branch
25+
26+
6. Modify tag
27+
28+
If you need to update stuff, remove tag and make sure the new tag is associated
29+
with CHANGELOG update.
30+
31+
```
32+
# Delete tag
33+
git tag -d v0.1
34+
git push --delete origin v0.1
35+
36+
# Make changes, rebase and tag again
37+
# Squash to one commit and make a nice commit message
38+
git rebase -i origin/master
39+
git tag -as v0.1 -m "Initial release."
40+
git push origin v0.1
41+
```

0 commit comments

Comments
 (0)