Skip to content

Commit fd52a87

Browse files
authored
docs: Improved release documentation (#440)
* docs: Improved release documentation * add information about GH template
1 parent 5242f83 commit fd52a87

File tree

2 files changed

+15
-3
lines changed

2 files changed

+15
-3
lines changed

.github/ISSUE_TEMPLATE/RELEASE_CHECKLIST.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,22 @@ about: Items to be completed in every release.
44
labels: Team:Delivery
55

66
---
7-
<!-- Before starting the release process please make sure you've -->
8-
<!-- read the release documentation in /developer_docs/RELEASE.md -->
97

108
## Version to be released
119
<!-- Please write the version to be released. -->
1210
<!-- It should follow the following format: vX.Y.Z -->
1311

1412
## Checklist
15-
<!-- The following actions must be performed in the order specified here. -->
13+
14+
The following actions must be performed in the order specified here.
15+
For detailed instructions on all of the steps, read the release [documentation](https://github.com/elastic/ecctl/blob/master/developer_docs/RELEASE.md).
16+
1617
- [ ] Verify a cloud-sdk-go release with the same version has been made.
1718
- [ ] Update the cloud-sdk-go dependency.
1819
- [ ] Update `VERSION` environment variable in the Makefile and generate changelog.
1920
- [ ] Execute the release.
2021
- [ ] Create release branch for documentation.
2122
- [ ] Modify the conf.yaml file in the docs repository to add the release branch.
2223
- [ ] Run a full doc rebuild.
24+
- [ ] Alert marketing team to update downloads website with new links.
2325
- [ ] Celebrate :tada:

developer_docs/RELEASE.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ This guide aims to provide guidance on how to release new versions of the `ecctl
44

55
## Prerequisites
66

7+
Before starting any release, make sure to open a release checklist [issue](https://github.com/elastic/ecctl/issues/403) using the provided release [template](https://github.com/elastic/ecctl/issues/new?assignees=&labels=Team%3ADelivery&template=RELEASE_CHECKLIST.md).
8+
79
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.
810

911
### Verify a release in cloud-sdk-go has been made
@@ -53,3 +55,11 @@ In order to have the documentation live for our new release we need to modify th
5355
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.
5456

5557
![alt text](docs-rebuild.png "rebuild instructions")
58+
59+
### Update downloads website
60+
61+
Once the release is done and the documentation is live, you'll need to get in touch with the marketing team to update the [downloads website](https://www.elastic.co/downloads/ecctl) with the correct links and information.
62+
63+
To do this you'll need to open up an issue similar to [this](https://github.com/elastic/website-www.elastic.co/issues/7163) one. In that issue you'll see a link to a google doc, do **NOT** directly edit this doc, but rather add as suggestions the changes to the links and information. The marketing team is pretty quick to answer, but should they miss this issue for some reason you can ping them in the #marketing channel.
64+
65+
There is an open [issue](https://github.com/elastic/ecctl/issues/428) to automate this process, but we've not had the bandwidth to dedicate time to work on this.

0 commit comments

Comments
 (0)