فهرست منبع

adjusting docs

Jhonny Mertz 2 سال پیش
والد
کامیت
e376942984
2فایلهای تغییر یافته به همراه10 افزوده شده و 0 حذف شده
  1. 1 0
      .github/workflows/publish.yml
  2. 9 0
      CONTRIBUTING.md

+ 1 - 0
.github/workflows/publish.yml

@@ -3,6 +3,7 @@ name: Release
 on:
 on:
   release:
   release:
     types: [created]
     types: [created]
+
 jobs:
 jobs:
   publish:
   publish:
     runs-on: ubuntu-latest
     runs-on: ubuntu-latest

+ 9 - 0
CONTRIBUTING.md

@@ -8,3 +8,12 @@ Running tests
 This repo has two kinds of tests: integration (dependent on `wkhtmltopdf`) and unit tests.
 This repo has two kinds of tests: integration (dependent on `wkhtmltopdf`) and unit tests.
 
 
 By default, `mvn clean install` runs all the tests. Use `mvn test -B` to run only the unit tests.
 By default, `mvn clean install` runs all the tests. Use `mvn test -B` to run only the unit tests.
+
+Generating releases
+------------
+
+Workflows are automated via Github Actions.
+
+In order to generate a new release:
+- Update the release version in pom.xml and README.md
+- Create a new release tag in github