Adding release to GitHub packages (#6)

- adding release job and release notes
- adding installation manual for Gradle and maven


## References

- TODO

<!-- References to relevant GitHub issues and pull requests, esp.
upstream and downstream changes -->

## Submitter checklist

- [ ] The PR request is well described and justified, including the body
and the references
- [ ] The PR title represents the desired changelog entry
- [ ] The repository's code style is followed (see the contributing
guide)
- [ ] Test coverage that demonstrates that the change works as expected
- [ ] For new features, there's necessary documentation in this pull
request or in a subsequent PR to
[wiremock.org](https://github.com/wiremock/wiremock.org)

<!--
Put an `x` into the [ ] to show you have filled the information.
The template comes from
https://github.com/wiremock/.github/blob/main/.github/pull_request_template.md
You can override it by creating .github/pull_request_template.md in your
own repository
-->

Author: dirkbolte

.github/release-drafter.yml

@@ -0,0 +1,2 @@
+# Use https://github.com/wiremock/.github/blob/main/.github/release_drafter.yml
+_extends: .github

.github/workflows/build-and-test.yml

@@ -2,11 +2,8 @@ name: Build and test
 
 on:
   push:
-#    branches: [ develop, master ]
     branches:
       - '**'
-#  pull_request:
-#    branches: [ develop, master ]
 
 jobs:
   validate:

.github/workflows/changelog-draft.yml

@@ -0,0 +1,22 @@
+name: Release Drafter
+
+on:
+  push:
+    branches:
+      - develop
+  workflow_dispatch:
+
+jobs:
+  update_release_draft:
+    permissions:
+      contents: write
+      pull-requests: write
+    runs-on: ubuntu-latest
+    steps:
+      - uses: release-drafter/release-drafter@v5
+        with:
+          name: next
+          tag: next
+          version: next
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/release.yml

@@ -0,0 +1,27 @@
+name: Release
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Java
+        uses: actions/setup-java@v3
+        with:
+          java-version: '11'
+          distribution: 'adopt'
+      - name: Validate Gradle wrapper
+        uses: gradle/wrapper-validation-action@v1
+      - name: Publish package
+        uses: gradle/gradle-build-action@v2
+        with:
+          arguments: publish
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -50,6 +50,54 @@ the `GET` won't have any knowledge of the previous post.
 
 # Usage
 
+## Compatibility matrix
+
+| `wiremock-extension-state` version | `WireMock` version |
+|------------------------------------|--------------------|
+| `0.0.3`                            | `3.0.0-beta-11`+   |
+
+## Installation
+
+### Gradle
+
+```groovy
+repositories {
+    maven {
+        url = uri("https://maven.pkg.github.com/wiremock/wiremock-extension-state")
+    }
+}
+
+
+dependencies {
+    testImplementation("org.wiremock:wiremock-state-extension:<your-version>")
+}
+```
+
+### Maven
+
+Follow the instructions on [GitHub Docs](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry) to
+add authentication to GitHub packages.  
+
+```xml
+
+<repositories>
+    <repository>
+        <id>github-wiremock-extension-state</id>
+        <name>WireMock Extension State Apache Maven Packages</name>
+        <url>https://maven.pkg.github.com/wiremock/wiremock-extension-state</url>
+    </repository>
+</repositories>
+
+<dependencies>
+    <dependency>
+        <groupId>org.wiremock</groupId>
+        <artifactId>wiremock-state-extension</artifactId>
+        <version>your-version</version>
+        <scope>test</scope>
+    </dependency>
+</dependencies>
+```
+
 ## Register extension
 
 This extension makes use of Wiremock's `ExtensionFactory`, so only one extension has to be registered: `StateExtension`.
@@ -198,12 +246,13 @@ Full example:
 
 ### state expiration
 
-This extension provides a `CaffeineStore` which uses [caffeine](https://github.com/ben-manes/caffeine) to store the current state and to achieve an expiration (to avoid memory leaks).
+This extension provides a `CaffeineStore` which uses [caffeine](https://github.com/ben-manes/caffeine) to store the current state and to achieve an expiration (
+to avoid memory leaks).
 The default expiration is 60 minutes. The default value can be overwritten (`0` = default = 60 minutes):
 
 ```java
 int expiration=1024;
-var store = new CaffeineStore(expiration);
+    var store=new CaffeineStore(expiration);
 ```
 
 ## Match a request against a context

build.gradle

@@ -12,13 +12,14 @@ plugins {
     id 'maven-publish'
     id 'jacoco'
     id 'com.diffplug.spotless' version '6.19.0'
+    id 'com.palantir.git-version' version '3.0.0'
 }
 
 wrapper {
     gradleVersion = '7.2'
     distributionType = Wrapper.DistributionType.BIN
 }
-project.archivesBaseName = 'state'
+project.archivesBaseName = 'wiremock-state-extension'
 project.ext {
     versions = [
             wiremock  : '3.0.0-beta-12',
@@ -32,19 +33,29 @@ project.ext {
 }
 
 
-group 'com.github.dirkbolte.wiremock.extensions'
-version '0.0.2-3.0.0-beta-11'
+group 'org.wiremock'
 
+version gitVersion()
 
 publishing {
+    repositories {
+        maven {
+            name = "GitHubPackages"
+            url = "https://maven.pkg.github.com/wiremock/wiremock-extension-state"
+            credentials {
+                username = System.getenv("GITHUB_ACTOR")
+                password = System.getenv("GITHUB_TOKEN")
+            }
+        }
+    }
     publications {
         mavenJava(MavenPublication) {
-            artifactId = 'state'
+            artifactId = 'wiremock-state-extension'
 
             from components.java
 
             pom {
-                name = 'state'
+                name = 'wiremock-state-extension'
                 description = 'A WireMock extension to transfer state in between stubs'
                 url = 'https://github.com/dirkbolte/wiremock-extension-state'