From 0c948941912e84c6d0ea1786777976b6d423db87 Mon Sep 17 00:00:00 2001
From: erezrokah <erezrokah@users.noreply.github.com>
Date: Thu, 16 Feb 2023 14:10:55 +0200
Subject: [PATCH 1/2] chore(docs): Add development and release guide

---
 README.md | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)

diff --git a/README.md b/README.md
index 30e0be6..a2327cc 100644
--- a/README.md
+++ b/README.md
@@ -61,3 +61,34 @@ spec:
 
 - `timeout_secs` (integer in seconds, optional. Default: 10):
   Timeout for requests against the Scaleway API endpoint.
+
+## Development
+
+### Run tests
+
+```bash
+make test
+```
+
+### Run linter
+
+```bash
+make lint
+```
+
+### Generate docs
+
+```bash
+make gen-docs
+```
+
+### Release a new version
+
+1. Follow [this link](https://github.com/scaleway/cq-source-scaleway/releases/new) to draft a new release.
+2. Click `Choose a tag` and enter the new version number:
+![image](https://user-images.githubusercontent.com/26760571/219360662-0ad1f83d-84c9-47c8-afb9-fe774ce03dcc.png)
+3. Click `Create new tag: <version> on publish` assuming it's a new tag.
+4. Click `Generate release notes` to automatically generate release notes.
+5. Click `Publish release` to publish the release.
+
+> Once the tag is pushed, a new GitHub Actions workflow will be triggered to build and upload the release binaries to the release

From c79740cb192be8c0c64960d5902336d6c253313f Mon Sep 17 00:00:00 2001
From: Erez Rokah <erezrokah@users.noreply.github.com>
Date: Thu, 16 Feb 2023 15:30:18 +0200
Subject: [PATCH 2/2] Update README.md

---
 README.md | 13 +++++--------
 1 file changed, 5 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index a2327cc..a9b5c7a 100644
--- a/README.md
+++ b/README.md
@@ -84,11 +84,8 @@ make gen-docs
 
 ### Release a new version
 
-1. Follow [this link](https://github.com/scaleway/cq-source-scaleway/releases/new) to draft a new release.
-2. Click `Choose a tag` and enter the new version number:
-![image](https://user-images.githubusercontent.com/26760571/219360662-0ad1f83d-84c9-47c8-afb9-fe774ce03dcc.png)
-3. Click `Create new tag: <version> on publish` assuming it's a new tag.
-4. Click `Generate release notes` to automatically generate release notes.
-5. Click `Publish release` to publish the release.
-
-> Once the tag is pushed, a new GitHub Actions workflow will be triggered to build and upload the release binaries to the release
+1. Run `git tag v1.0.0` to create a new tag for the release (replace `v1.0.0` with the new version number)
+2. Run `git push origin v1.0.0` to push the tag to GitHub  
+
+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.
+To customize the release notes, see the Go releaser [changelog configuration docs](https://goreleaser.com/customization/changelog/#changelog).