Skip to content

Commit a6823b5

Browse files
author
Julien Castets
committed
MAINTAINERS.md: fix markdown indentation
1 parent 8d220c4 commit a6823b5

File tree

1 file changed

+21
-54
lines changed

1 file changed

+21
-54
lines changed

MAINTAINERS.md

Lines changed: 21 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,90 +1,58 @@
1-
**This guide is intended for scaleway-cli maintainers. If you are not a
2-
maintainer, you probably want to check out the [documentation](README.md)
3-
instead.**
1+
**This guide is intended for scaleway-cli maintainers. If you are not a maintainer, you probably want to check out the [documentation](README.md) instead.**
42

53
## Package release HOWTO
64

7-
Ready to deploy a new version to users? Let's make a checklist of what you need
8-
to do.
5+
Ready to deploy a new version to users? Let's make a checklist of what you need to do.
96

10-
For the sake of the example, we assume you want to release the version `42.8`
11-
and the previous version was `42.7`.
7+
For the sake of the example, we assume you want to release the version `42.8` and the previous version was `42.7`.
128

139
### Commit release
1410

1511
* Edit the Changelog at the bottom of [README.md](README.md).
1612

1713
- Header: change the version from *v42.7* version) to *v42.8*
1814
- Header: replace "unreleased" with the current date
19-
- Content: read commits history, and fill the changelog if it's not already
20-
done
21-
- In the "To install a release" section, grep *v42.7* and replace with
22-
*v42.8*
23-
- Footer: edit the "View full commit list" link from */compare/v42.7..master*
24-
to */compare/v42.7..v42.8*
25-
26-
* Edit [pkg/scwversion/version.go](pkg/scwversion/version.go) and update the
27-
*VERSION* to *v42.8*.
15+
- Content: read commits history, and fill the changelog if it's not already done
16+
- In the "To install a release" section, grep *v42.7* and replace with *v42.8*
17+
- Footer: edit the "View full commit list" link from */compare/v42.7..master* to */compare/v42.7..v42.8*
18+
19+
* Edit [pkg/scwversion/version.go](pkg/scwversion/version.go) and update the *VERSION* to *v42.8*.
2820
* Make the commit release: `git commit -a -m 'Release v42.8'`.
2921
* Tag the commit: `git tag v42.8`.
3022
* Push: `git push && git push --tags`.
3123

3224
### Make a github release
3325

34-
* [Draft a new release](https://github.com/scaleway/scaleway-cli/releases) on
35-
Github.
36-
* Build cross-compiled files: `make prepare-release-dist`. *This step relies on
37-
the go compiler, which is able to cross compile go projects. If you hack on
38-
the scaleway-cli in a Docker container, you can run this step from your
39-
container.*
40-
* Build debian packages: `make prepare-release-debian-packages VERSION=42.8`.
41-
**The VERSION should not include the leading "v"**. *This step runs Docker
42-
containers. If you are hacking on scaleway-cli with Docker, you need to build
43-
the Debian packages from the Docker host, and not from your container.*
26+
* [Draft a new release](https://github.com/scaleway/scaleway-cli/releases) on Github.
27+
* Build cross-compiled files: `make prepare-release-dist`. *This step relies on the go compiler, which is able to cross compile go projects. If you hack on the scaleway-cli in a Docker container, you can run this step from your container.*
28+
* Build debian packages: `make prepare-release-debian-packages VERSION=42.8`. **The VERSION should not include the leading "v"**. *This step runs Docker containers. If you are hacking on scaleway-cli with Docker, you need to build the Debian packages from the Docker host, and not from your container.*
4429
* Upload the Debian packages generated in `dist/latest`.
4530
* Publish the release.
4631

4732
### Docker image
4833

49-
* Call `make prepare-release-docker-image VERSION=42.8`. **The VERSION should
50-
not include the leading "v"**. *This step runs Docker containers. If you are
51-
hacking on scaleway-cli with Docker, run this step from the Docker host and
52-
not from your container.*
34+
* Call `make prepare-release-docker-image VERSION=42.8`. **The VERSION should not include the leading "v"**. *This step runs Docker containers. If you are hacking on scaleway-cli with Docker, run this step from the Docker host and not from your container.*
5335
* Push the local Docker image to the Docker hub: `docker push scaleway/cli`.
5436

5537
### Homebrew (OSX) package
5638

57-
* Get the released archive's sha256sum: `curl -sL
58-
https://github.com/scaleway/scaleway-cli/archive/v42.8.tar.gz | shasum -a
59-
256`.
39+
* Get the released archive's sha256sum: `curl -sL https://github.com/scaleway/scaleway-cli/archive/v42.8.tar.gz | shasum -a 256`.
6040
* Clone the homebrew Github repository: `git clone [email protected]:Homebrew/homebrew-core.git` to you personal account.
61-
* Edit *Formula/scw.rb* and fix the *URL* **AND** the *sha256* **on top** of
62-
the file. You don't need to edit the SHAsums below. They will be updated
63-
automatically by Homebrew maintainers when the PR will be merged.
64-
* Ensure the formula works: `brew install --build-from-source Formula/scw.rb`.
65-
You will probably need to uninstall your current installation of scaleway-cli
66-
before installing the formula.
67-
* Commit with `git commit -a -m 'scw 42.8'` and make a pull request from your
68-
repository to [homebrew](https://github.com/Homebrew/homebrew-core) to make
69-
your new version official.
41+
* Edit *Formula/scw.rb* and fix the *URL* **AND** the *sha256* **on top** of the file. You don't need to edit the SHAsums below. They will be updated automatically by Homebrew maintainers when the PR will be merged.
42+
* Ensure the formula works: `brew install --build-from-source Formula/scw.rb`. You will probably need to uninstall your current installation of scaleway-cli before installing the formula.
43+
* Commit with `git commit -a -m 'scw 42.8'` and make a pull request from your repository to [homebrew](https://github.com/Homebrew/homebrew-core) to make your new version official.
7044

7145
### Archlinux package
7246

73-
**This section is incomplete. Edit this part if you have additional
74-
informations.**
47+
**This section is incomplete. Edit this part if you have additional informations.**
7548

76-
There is a Archlinux community package (aka. "AUR" — Archlinux User Repository)
77-
for scaleway-cli: https://aur.archlinux.org/packages/scaleway-cli/ maintained
78-
by "moscar". We should probably ping him when we make a new release.
49+
There is a Archlinux community package (aka. "AUR" — Archlinux User Repository) for scaleway-cli: https://aur.archlinux.org/packages/scaleway-cli/ maintained by "moscar". We should probably ping him when we make a new release.
7950

8051
### Update VERSION file
8152

82-
From time to time, scaleway-cli makes a HTTP query to
83-
https://fr-1.storage.online.net/scaleway/scaleway-cli/VERSION to check if it is
84-
at the latest version available. This file needs to be updated.
53+
From time to time, scaleway-cli makes a HTTP query to https://fr-1.storage.online.net/scaleway/scaleway-cli/VERSION to check if it is at the latest version available. This file needs to be updated.
8554

86-
**PLEASE WAIT UNTIL THE HOMEBREW PULL REQUEST IS ACCEPTED BEFORE UPDATING THE
87-
VERSION FILE.**
55+
**PLEASE WAIT UNTIL THE HOMEBREW PULL REQUEST IS ACCEPTED BEFORE UPDATING THE VERSION FILE.**
8856

8957

9058
```
@@ -108,5 +76,4 @@ $> curl https://fr-1.storage.online.net/scaleway/scaleway-cli/VERSION
10876
View full [commits list](https://github.com/scaleway/scaleway-cli/compare/v42.8...master)
10977
```
11078

111-
* Edit [pkg/scwversion/version.go](pkg/scwversion/version.go) and set *VERSION*
112-
to *v42.8+dev*.
79+
* Edit [pkg/scwversion/version.go](pkg/scwversion/version.go) and set *VERSION* to *v42.8+dev*.

0 commit comments

Comments
 (0)