You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: Update release documentation and release GH issue template (#274)
A few changes have been made to the release process. They are now documented.
In order to make sure we don't miss any steps while releasing, I am adding a release
GH issue template. This template contains a checklist we must follow for every release.
This issue for every release can also be helpful to have conversations about every release in one place.
Copy file name to clipboardExpand all lines: developer_docs/RELEASE.md
+23-3Lines changed: 23 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,6 +6,12 @@ This guide aims to provide guidance on how to release new versions of the `ecctl
6
6
7
7
Releasing a new version of the binary implies that there have been changes in the source code which are meant to be released for wider consumption. Before releasing a new version there's some prerequisites that have to be checked.
8
8
9
+
### Verify a release in cloud-sdk-go has been made
10
+
11
+
Unless this is a patch release, make sure a cloud-sdk-go release with the same version has been made.
12
+
13
+
Once this is done, the cloud-sdk-go dependency should be updated to that version.
14
+
9
15
### Make sure the version is updated
10
16
11
17
Since the source has changed, we need to update the current committed version to a higher version so that the release is published.
@@ -26,10 +32,24 @@ export VERSION ?= v1.1.0
26
32
27
33
### Generating a changelog for the new version
28
34
29
-
Once the version is updated, we can then generate the changelog by calling `make changelog`, you can see an example changelog in [`notes/EXAMPLE.md`](../notes/EXAMPLE.md). The idea is to fill all the applicable sections so that users can consume an orderly changelog.
35
+
Once the version is updated, we can then generate the changelog and release notes by calling `make changelog`.
30
36
31
-
After a changelog has been manually curated, a new pull request can be opened with the changelog and version update changes.
37
+
Take a look at one of our previous releases [`v1.0.0-beta2.adoc`](../docs/release_notes/v1.0.0-beta2.adoc) and the [template](../scripts/changelog.tpl.adoc) we use to generate them. The idea is to fill all the applicable sections so that users can consume easily.
38
+
39
+
After the release notes have been manually curated, a new pull request can be opened with the changelog, release notes and version update changes.
32
40
33
41
## Executing the release
34
42
35
-
After the new changelog and version have been merged to master, the only thing remaining is to run `make tag`. This is the makefile target which will push the GitHub tag and will trigger the corresponding [GitHub action](.github/workflows/release.yml) which will release ecctl.
43
+
After the new changelog and version have been merged to master, the only thing remaining is to run `make release`. This is the makefile target which will push the GitHub tag and will trigger the corresponding [GitHub action](.github/workflows/release.yml) which will release ecctl.
44
+
45
+
## Post release requirements
46
+
47
+
After a release has been performed there are still a few things we need to do.
48
+
49
+
### Create documentation specific to the release
50
+
51
+
Inordertohavethedocumentationliveforournewreleaseweneedtomodifytheconf.yamlfileinthedocsrepositoryto[addthereleasebranch](https://github.com/elastic/docs/blob/master/conf.yaml#L837) and have the build [point to our new branch](https://github.com/elastic/docs/blob/master/conf.yaml#L836).
52
+
53
+
OncethePRfortheabovechangeshasbeenmerged,you'llneedtorunafulldoc[rebuild](https://elasticsearch-ci.elastic.co/job/elastic+docs+master+build/build?delay=0sec) to make the new release branch the default docs.
0 commit comments