Skip to content

Commit 53cafd8

Browse files
authored
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.
1 parent 629d5cf commit 53cafd8

File tree

6 files changed

+49
-6
lines changed

6 files changed

+49
-6
lines changed

.github/ISSUE_TEMPLATE/BUG_REPORT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
name: Bug Report
33
about: Create a report to help us improve.
4-
labels: area:tooling
4+
labels: area:delivery
55

66
---
77
<!--- Thank you for taking the time to create a Bug Report! -->

.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
name: Feature Request
33
about: Suggest an idea for this project.
4-
labels: area:tooling
4+
labels: area:delivery
55

66
---
77
<!--- Thank you for taking the time to open a Feature Request -->

.github/ISSUE_TEMPLATE/GENERIC_QUESTION.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
name: Generic Question
33
about: Not a Bug Report or a Feature Request? Ask a question.
4-
labels: area:tooling
4+
labels: area:delivery
55

66
---
77
<!--- Thank you for taking the time to ask us a question! -->
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: Release Checklist
3+
about: Items to be completed in every release.
4+
labels: area:delivery
5+
6+
---
7+
<!-- Before starting the release process please make sure you've -->
8+
<!-- read the release documentation in /developer_docs/RELEASE.md -->
9+
10+
## Version to be released
11+
<!-- Please write the version to be released. -->
12+
<!-- It should follow the following format: vX.Y.Z -->
13+
14+
## Checklist
15+
<!-- The following actions must be performed in the order specified here. -->
16+
- [ ] Verify a cloud-sdk-go release with the same version has been made.
17+
- [ ] Update the cloud-sdk-go dependency.
18+
- [ ] Update `VERSION` environment variable in the Makefile and generate changelog.
19+
- [ ] Execute the release.
20+
- [ ] Create release branch for documentation.
21+
- [ ] Modify the conf.yaml file in the docs repository to add the release branch.
22+
- [ ] Run a full doc rebuild.
23+
- [ ] Celebrate :tada:

developer_docs/RELEASE.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@ This guide aims to provide guidance on how to release new versions of the `ecctl
66

77
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.
88

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+
915
### Make sure the version is updated
1016

1117
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
2632

2733
### Generating a changelog for the new version
2834

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`.
3036

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.
3240

3341
## Executing the release
3442

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+
In order to have the documentation live for our new release we need to modify the conf.yaml file in the docs repository to [add the release branch](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+
Once the PR for the above changes has been merged, you'll need to run a full doc [rebuild](https://elasticsearch-ci.elastic.co/job/elastic+docs+master+build/build?delay=0sec) to make the new release branch the default docs.
54+
55+
![alt text](docs-rebuild.png "rebuild instructions")

developer_docs/docs-rebuild.png

142 KB
Loading

0 commit comments

Comments
 (0)