Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[YUNIKORN-1960] Add updating DOAP file to release tasks #356

Closed
wants to merge 2 commits into from
Closed

[YUNIKORN-1960] Add updating DOAP file to release tasks #356

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5b12279
[YUNIKORN-1960] Add updating DOAP file to release tasks
Oct 20, 2023
a9bf64b
Addressing review comments
Oct 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 18 additions & 3 deletions src/pages/community/release_procedure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,9 +61,10 @@ 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. 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
5. Update the DOAP file
vani-gupta marked this conversation as resolved.
Show resolved Hide resolved
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

## Step-by-step procedure
Branching and tagging can, and in most cases will, require changes in the go mod files.
Expand Down Expand Up @@ -120,6 +121,20 @@ 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