Skip to content

Commit 22967f8

Browse files
authored
chore(docs): Add development and release guide (#5)
1 parent b647471 commit 22967f8

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

+28
Original file line numberDiff line numberDiff line change
@@ -61,3 +61,31 @@ spec:
6161

6262
- `timeout_secs` (integer in seconds, optional. Default: 10):
6363
Timeout for requests against the Scaleway API endpoint.
64+
65+
## Development
66+
67+
### Run tests
68+
69+
```bash
70+
make test
71+
```
72+
73+
### Run linter
74+
75+
```bash
76+
make lint
77+
```
78+
79+
### Generate docs
80+
81+
```bash
82+
make gen-docs
83+
```
84+
85+
### Release a new version
86+
87+
1. Run `git tag v1.0.0` to create a new tag for the release (replace `v1.0.0` with the new version number)
88+
2. Run `git push origin v1.0.0` to push the tag to GitHub
89+
90+
Once the tag is pushed, a new GitHub Actions workflow will be triggered to build the release binaries and create the new release on GitHub.
91+
To customize the release notes, see the Go releaser [changelog configuration docs](https://goreleaser.com/customization/changelog/#changelog).

0 commit comments

Comments
 (0)