Automate more release steps

Add workflow to prepare the release.
Tweak existing workflow to do the release on merge.
Move version (and add release state) to a properties file to ease the
automation.
Update Gradle add-on plugin and build for the release automation.
Document steps to release the add-on.

Signed-off-by: thc202 <[email protected]>

Author: thc202

.github/workflows/prepare-release-add-on.yml

@@ -0,0 +1,22 @@
+name: Prepare Release Add-on
+
+on:
+  workflow_dispatch:
+
+jobs:
+  prepare-release:
+    name: Prepare Release
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        fetch-depth: 0
+        persist-credentials: false
+    - name: Setup Java
+      uses: actions/setup-java@v1
+      with:
+        java-version: 8
+    - name: Prepare Release and Create Pull Request
+      env:
+        ZAPBOT_TOKEN: ${{ secrets.ZAPBOT_TOKEN }}
+      run: ./gradlew createPullRequestRelease

.github/workflows/release-add-on.yml

@@ -2,20 +2,27 @@ name: Release Add-On
 
 on:
   push:
-    tags:
-      - 'v*'
+    branches:
+      - main
+    paths:
+      - 'gradle.properties'
 
 jobs:
   release:
     name: Build and Release Add-On
-    if: github.actor == 'kingthorin' || github.actor == 'psiinon' || github.actor == 'thc202'
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v2
+      with:
+        fetch-depth: 0
+        persist-credentials: false
+    - name: Setup Java
+      uses: actions/setup-java@v1
+      with:
+        java-version: 8
+    - name: Generate Release State
+      run: ./gradlew generateReleaseStateLastCommit
     - name: Build and Release Add-On
-      uses: docker://openjdk:8
       env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      with:
-        entrypoint: ./gradlew
-        args: createReleaseFromGitHubRef
+        ZAPBOT_TOKEN: ${{ secrets.ZAPBOT_TOKEN }}
+      run: ./gradlew releaseAddOn

RELEASING.md

@@ -0,0 +1,9 @@
+# Release
+
+The following steps should be followed to release the add-on:
+ 1. Run the workflow [Prepare Release Add-on](https://github.com/zaproxy/community-scripts/actions/workflows/prepare-release-add-on.yml),
+    to prepare the release. It creates a pull request updating the version and changelog;
+ 2. Merge the pull request.
+
+After merging the pull request the [Release Add-on](https://github.com/zaproxy/community-scripts/actions/workflows/release-add-on.yml) workflow
+will create the tag, create the release, trigger the update of the marketplace, and create a pull request preparing the next development iteration.

build.gradle.kts

@@ -1,20 +1,19 @@
-import org.zaproxy.gradle.addon.AddOnPlugin
 import org.zaproxy.gradle.addon.AddOnStatus
+import org.zaproxy.gradle.addon.internal.model.ProjectInfo
+import org.zaproxy.gradle.addon.internal.model.ReleaseState
+import org.zaproxy.gradle.addon.internal.tasks.GenerateReleaseStateLastCommit
 import org.zaproxy.gradle.addon.misc.ConvertMarkdownToHtml
-import org.zaproxy.gradle.addon.misc.CreateGitHubRelease
-import org.zaproxy.gradle.addon.misc.ExtractLatestChangesFromChangelog
 
 plugins {
     `java-library`
-    id("org.zaproxy.add-on") version "0.5.0"
+    id("org.zaproxy.add-on") version "0.6.0"
     id("com.diffplug.spotless") version "5.12.1"
 }
 
 repositories {
     mavenCentral()
 }
 
-version = "10"
 description = "Useful ZAP scripts written by the ZAP community."
 
 val scriptsDir = layout.buildDirectory.dir("scripts")
@@ -112,33 +111,15 @@ spotless {
     }
 }
 
-System.getenv("GITHUB_REF")?.let { ref ->
-    if ("refs/tags/" !in ref) {
-        return@let
-    }
-
-    tasks.register<CreateGitHubRelease>("createReleaseFromGitHubRef") {
-        val targetTag = ref.removePrefix("refs/tags/")
-        val targetAddOnVersion = targetTag.removePrefix("v")
-
-        authToken.set(System.getenv("GITHUB_TOKEN"))
-        repo.set(System.getenv("GITHUB_REPOSITORY"))
-        tag.set(targetTag)
-
-        title.set(provider { "Version ${zapAddOn.addOnVersion.get()}" })
-        bodyFile.set(tasks.named<ExtractLatestChangesFromChangelog>("extractLatestChanges").flatMap { it.latestChanges })
-
-        assets {
-            register("add-on") {
-                file.set(tasks.named<Jar>(AddOnPlugin.JAR_ZAP_ADD_ON_TASK_NAME).flatMap { it.archiveFile })
-            }
-        }
+val projectInfo = ProjectInfo.from(project)
+val generateReleaseStateLastCommit by tasks.registering(GenerateReleaseStateLastCommit::class) {
+    projects.set(listOf(projectInfo))
+}
 
-        doFirst {
-            val addOnVersion = zapAddOn.addOnVersion.get()
-            require(addOnVersion == targetAddOnVersion) {
-                "Version of the tag $targetAddOnVersion does not match the version of the add-on $addOnVersion"
-            }
-        }
+val releaseAddOn by tasks.registering {
+    if (ReleaseState.read(projectInfo).isNewRelease()) {
+        dependsOn("createRelease")
+        dependsOn("handleRelease")
+        dependsOn("createPullRequestNextDevIter")
     }
 }

gradle.properties

@@ -0,0 +1,2 @@
+version=10
+release=false