docs: add development.md

Signed-off-by: Josef Andersson <[email protected]>
diggsweden · Jan 29, 2025 · d8abf9e · d8abf9e
1 parent 1d43677
commit d8abf9e
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -16,4 +16,6 @@ SPDX-License-Identifier: EUPL-1.2
 
 A PoC Library to support different token formats for EUDI wallet such as SD-JWT and mDL
 
-TO-DO: Add documentation
+TO-DO: Add documentation
+
+[Development](./docs/DEVELOPMENT.md)
diff --git a/REUSE.toml b/REUSE.toml
@@ -11,6 +11,7 @@ path = [
   "renovate.json",
   "src/test/resources/simplelogger.properties",
   "CHANGELOG.md",
+  "docs/DEVELOPMENT.md",
   "jreleaser.yml",
   "README.md",
 ]

diff --git a/docs/DEVELOPMENT.md b/docs/DEVELOPMENT.md
@@ -0,0 +1,22 @@
+# Development Guide Lines
+
+TO-DO
+
+## Tag and Release a new version
+
+Activate the GH-workflow with a tag and push
+
+Example:
+
+```shell
+git tag -s v0.0.3-SNAPSHOT -m 'v0.0.3-SNAPSHOT'
+git push origin tag v0.0.3
+```
+
+Currently only publishing to GitHub-packages
+
+## Run same code quality tests locally as in CI
+
+```shell
+./developement/codequality.sh
+```
diff --git a/jreleaser.yml b/jreleaser.yml
@@ -17,7 +17,7 @@ release:
   github:
     owner: diggsweden
     overwrite: true     # Allows updating existing releases
-    draft: true        # Creates as final release, not draft
+    draft: false        # Creates as final release, not draft
     sign: true          # Signs release assets
     branch: main
     changelog: