Skip to content

Commit 8c26238

Browse files
authored
adding release notes workflow (#370)
* adding release notes workflow * add releasing doc
1 parent b2cb8d0 commit 8c26238

5 files changed

+91
-2
lines changed
+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# The overall template of the release notes
2+
template: |
3+
$CHANGES
4+
5+
# Setting the formatting and sorting for the release notes body
6+
name-template: Version (set version here)
7+
change-template: "* $TITLE ([#$NUMBER]($URL))"
8+
sort-by: merged_at
9+
sort-direction: ascending
10+
replacers:
11+
- search: "##"
12+
replace: "###"
13+
14+
# Organizing the tagged PRs into unified categories
15+
categories:
16+
- title: "Breaking changes"
17+
labels:
18+
- "breaking change"
19+
- title: "Features"
20+
labels:
21+
- "feature"
22+
- title: "Enhancements"
23+
labels:
24+
- "enhancement"
25+
- title: "Bug Fixes"
26+
labels:
27+
- "bug"
28+
- "bug fix"
29+
- title: "Infrastructure"
30+
labels:
31+
- "infra"
32+
- "test"
33+
- "dependencies"
34+
- "github actions"
35+
- title: "Documentation"
36+
labels:
37+
- "documentation"
38+
- title: "Maintenance"
39+
labels:
40+
- "version upgrade"
41+
- "odfe release"
42+
- title: "Refactoring"
43+
labels:
44+
- "refactor"
45+
- "code quality"
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Release Drafter
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
jobs:
9+
update_release_draft:
10+
name: Update draft release notes
11+
runs-on: ubuntu-latest
12+
steps:
13+
- name: Update draft release notes
14+
uses: release-drafter/release-drafter@v5
15+
with:
16+
config-name: draft-release-notes-config.yml
17+
name: Version (set here)
18+
tag: (None)
19+
env:
20+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/maven-release.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ jobs:
2626
with:
2727
java-version: 17
2828
cache: maven
29-
server-id: ossrh-release
29+
server-id: ossrh
3030
server-username: MAVEN_USERNAME
3131
server-password: MAVEN_PASSWORD
3232
gpg-private-key: ${{ secrets.MAVEN_GPG_PRIVATE_KEY }}

Java/RELEASING.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
- [Overview](#overview)
2+
- [Feature Branches](#feature-branches)
3+
- [Release Labels](#release-labels)
4+
- [Releasing](#releasing)
5+
6+
## Overview
7+
8+
This document explains the release strategy for the Random Cut Forest project.
9+
10+
## Feature Branches
11+
12+
Do not create branches in the upstream repo, use your fork, for the exception of long lasting feature branches that require active collaboration from multiple developers. Name feature branches `feature/<thing>`. Once the work is merged to `main`, please make sure to delete the feature branch.
13+
14+
## Release Labels
15+
16+
Repositories create consistent release labels, such as `3.0.0-java`. Use release labels to target an issue or a PR for a given release.
17+
18+
## Releasing
19+
20+
The release process is run by a release manager volunteering from amongst the maintainers.
21+
22+
1. Create a PR to bump version to desired release candidate (e.g. 3.0.0)
23+
2. Click run on the maven-release workflow in Github Actions which uploads the artifacts to our staging repository, creates a new tag, and a new Github release
24+
3. Login into the nexus staging repositor , verify artifact was signed succesfully and click release to officially push to maven central.

Java/pom.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,7 @@
214214
<url>https://aws.oss.sonatype.org/content/repositories/snapshots</url>
215215
</snapshotRepository>
216216
<repository>
217-
<id>ossrh-release</id>
217+
<id>ossrh</id>
218218
<url>https://oss.sonatype.org/service/local/staging/deploy/maven2/</url>
219219
</repository>
220220
</distributionManagement>

0 commit comments

Comments
 (0)