Skip to content

Commit

Permalink
Addressing review comments
Browse files Browse the repository at this point in the history
  • Loading branch information
Vani Prakash Gupta committed Oct 24, 2023
1 parent 5b12279 commit a9bf64b
Showing 1 changed file with 17 additions and 18 deletions.
35 changes: 17 additions & 18 deletions src/pages/community/release_procedure.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,10 +61,9 @@ Simplified release procedure:
2. Stabilize the release by fixing test failures and bugs only
3. Tag update release for a new version to prepare a release candidate, e.g `v1.3.0-1` for RC1
4. Update the CHANGELOG
5. Update the DOAP file
6. Configure [release-configs.json](https://github.com/apache/yunikorn-release/tree/master/tools/release-configs.json)
7. Run script [build-release.py](https://github.com/apache/yunikorn-release/tree/master/tools/build-release.py) to generate source code tarball, checksum and signature.
8. Voting and releasing the candidate
5. Configure [release-configs.json](https://github.com/apache/yunikorn-release/tree/master/tools/release-configs.json)
6. Run script [build-release.py](https://github.com/apache/yunikorn-release/tree/master/tools/build-release.py) to generate source code tarball, checksum and signature.
7. Voting and releasing the candidate

## Step-by-step procedure
Branching and tagging can, and in most cases will, require changes in the go mod files.
Expand Down Expand Up @@ -121,20 +120,6 @@ Follow these steps to generate the list:
- Select the style `Text` and click `create`
- Scroll to the bottom of the page and copy the content of the text area and update the CHANGELOG file in the ../release-top-level-artifacts directory.

### Update the DOAP file
A [DOAP file](https://github.com/apache/yunikorn-site/blob/master/doap_YuniKorn.rdf) containing project details has to be maintained.
Update the DOAP file with the release version and release date.

```xml
<release>
<Version>
<name>YuniKorn x.y.z</name>
<created>YYYY-MM-DD</created>
<revision>x.y.z</revision>
</Version>
</release>
```

### Run the release tool
Please check the [signing your first release](#signing-your-first-release) before proceeding here for details on signing a release.
Limitations apply to the key that can be used for signing.
Expand Down Expand Up @@ -478,6 +463,20 @@ Links for the releases have to follow these rules:
A limited set of three (3) or four (4) releases should be maintained in the table for direct access.
Older releases not mentioned in the table can still be accessed via the archive link on the bottom of the page and do not need to be referenced.

### Update the DOAP file
A [DOAP file](https://github.com/apache/yunikorn-site/blob/master/doap_YuniKorn.rdf) containing project details has to be maintained.
Update the DOAP file with the release version and release date.

```xml
<release>
<Version>
<name>YuniKorn x.y.z</name>
<created>YYYY-MM-DD</created>
<revision>x.y.z</revision>
</Version>
</release>
```

## Signing your first release
If you haven't signed any releases before, read the documentation to [generate signing key](https://infra.apache.org/openpgp.html#generate-key)
Follow the steps below to add the key you can use to sign.
Expand Down

0 comments on commit a9bf64b

Please sign in to comment.