Improve releases with auto release notes

Author: hierynomus

.github/labeler.yml

@@ -0,0 +1,25 @@
+dependencies:
+  - changed-files:
+    - any-glob-to-any-file:
+      - 'build.gradle'
+      - 'build-publishing.gradle'
+      - 'settings.gradle'
+      - 'gradle/**'
+      - 'mise.toml'
+      - 'gradlew'
+      - 'gradlew.bat'
+
+infrastructure:
+  - changed-files:
+    - any-glob-to-any-file:
+      - '.github/**'
+
+documentation:
+  - changed-files:
+    - any-glob-to-any-file:
+      - 'README.adoc'
+      - 'CONTRIBUTORS'
+      - 'NOTICE'
+      - 'LICENSE'
+      - 'LICENSE_HEADER'
+      - 'examples/**'

.github/release-drafter.yml

@@ -0,0 +1,60 @@
+name-template: 'SSHJ $RESOLVED_VERSION'
+tag-template: 'v$RESOLVED_VERSION'
+
+categories:
+  - title: '🔒 Security'
+    labels:
+      - 'security'
+  - title: '🐛 Bug Fixes'
+    labels:
+      - 'bug'
+      - 'fix'
+  - title: '✨ New Features'
+    labels:
+      - 'enhancement'
+      - 'feature'
+  - title: '📦 Dependency Updates'
+    labels:
+      - 'dependencies'
+      - 'dependency-upgrade'
+  - title: '🔨 Improvements'
+    labels:
+      - 'improvement'
+      - 'refactoring'
+      - 'cleanup'
+  - title: '📝 Documentation'
+    labels:
+      - 'documentation'
+  - title: '🏗️ Infrastructure'
+    labels:
+      - 'ci'
+      - 'build'
+      - 'infrastructure'
+
+change-template: '* $TITLE (#$NUMBER) @$AUTHOR'
+change-title-escapes: '\<*_&'
+
+version-resolver:
+  major:
+    labels:
+      - 'major'
+  minor:
+    labels:
+      - 'minor'
+      - 'enhancement'
+      - 'feature'
+  patch:
+    labels:
+      - 'patch'
+      - 'bug'
+      - 'fix'
+      - 'security'
+      - 'dependencies'
+  default: minor
+
+template: |
+  ## Changes
+
+  $CHANGES
+
+  **Full Changelog**: https://github.com/$OWNER/$REPOSITORY/compare/$PREVIOUS_TAG...v$RESOLVED_VERSION

.github/workflows/labeler.yml

@@ -0,0 +1,46 @@
+name: Labeler
+
+on:
+  pull_request:
+    types: [opened, edited, synchronize, reopened]
+
+permissions:
+  contents: read
+  pull-requests: write
+
+jobs:
+  label-by-files:
+    name: Label by changed files
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/labeler@v5
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+          sync-labels: false
+
+  label-by-title:
+    name: Label by PR title
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/github-script@v7
+        with:
+          script: |
+            const title = context.payload.pull_request.title.toLowerCase();
+
+            const rules = [
+              { label: 'security',     re: /\b(cve|security|vulnerability|exploit|terrapin)\b/ },
+              { label: 'bug',          re: /\b(fix(es|ed|ing)?|bug|regression|broken|crash)\b/ },
+              { label: 'enhancement',  re: /\b(add(s|ed|ing)?|support(s|ed|ing)?|implement(s|ed)?|feature)\b/ },
+              { label: 'dependencies', re: /\b(upgrad(e|es|ed|ing)|bump(s|ed)?|depend(ency|encies))\b/ },
+              { label: 'improvement',  re: /\b(refactor(ed|ing)?|clean(up)?|improv(e|es|ed|ing)|remov(e|es|ed|ing)|replac(e|es|ed|ing))\b/ },
+            ];
+
+            const toAdd = rules.filter(r => r.re.test(title)).map(r => r.label);
+            if (toAdd.length === 0) return;
+
+            await github.rest.issues.addLabels({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              issue_number: context.payload.pull_request.number,
+              labels: toAdd,
+            });

.github/workflows/release-drafter.yml

@@ -0,0 +1,20 @@
+name: Release Drafter
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    types: [opened, reopened, synchronize]
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  update_release_draft:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: release-drafter/release-drafter@v6
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/release.yml

@@ -47,3 +47,10 @@ jobs:
           ORG_GRADLE_PROJECT_signingPassword: ${{ secrets.SIGNINGPASSWORD }}
           ORG_GRADLE_PROJECT_sonatypeUsername: ${{ secrets.OSSRH_USERNAME }}
           ORG_GRADLE_PROJECT_sonatypePassword: ${{ secrets.OSSRH_PASSWORD }}
+      - name: Publish GitHub Release
+        uses: release-drafter/release-drafter@v6
+        with:
+          publish: true
+          tag: ${{ github.ref_name }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.adoc

@@ -115,6 +115,10 @@ Issue tracker: https://github.com/hierynomus/sshj/issues
 Fork away!
 
 == Release history
+Starting from version 0.40.0, release notes are published as https://github.com/hierynomus/sshj/releases[GitHub Releases].
+
+The history below covers releases up to and including 0.39.0.
+
 SSHJ 0.39.0 (2024-02-20)::
 * Upgraded dependencies
 * Remove hard dependencies on BouncyCastle, making it optional.