(this page is for developing and maintaining this project)
Following instructions apply to Windows machines:
- Run PowerShell as Administrator -- required by Chocolatey
- Install Chocolatey -- https://chocolatey.org/install#individual
choco install -y jdk8
choco install -y git
choco install -y tortoisegit
choco install -y intellijidea-community
orchoco install eclipse-java-oxygen
There should be alternative commands for Mac and various Linux distros.
Either copy development-maven-settings.xml to
your ~/.m2
as settings.xml
, or run Maven with
mvnw -settings development-maven-settings.xml
from this directory.
Project settings are shared via .idea
folder
see https://www.jetbrains.com/help/idea/creating-and-managing-projects.html#share-project-through-vcs
and https://www.jetbrains.com/help/idea/sharing-your-ide-settings.html#settings-repository
Screenshots and tracing logs require AspectJ instrumentation. AspectJ plugin is required in order to compile, run and debug in an IDE:
- Eclipse -- https://www.eclipse.org/ajdt/
- IntelliJ -- bundled (https://www.jetbrains.com/help/idea/aspectj.html),
requires additional configuration as follows:
- ajc (AspectJ Compiler) must be used
- AspectJ facet must be configured in "post-compile weave mode" for
following modules:
qa-testing
,qa-jgiven-utils
andqa-jgiven-commons
mvnw
on the root project will run all tests.
By pushing or merging into main branch. See the deploy-for-jdk8.
We use SemVer for versioning.
To initiate a release, run the Release action.
The above has the following effects:
SNAPSHOT
suffix will be removed- sources will be committed and tagged according to current version
- artifacts will be deployed to OSSRH
- versions will be bumped up forming a new SNAPSHOT
- a new commit will be made on main branch
- after few hours released artifacts will appear on Maven Central at https://search.maven.org/search?q=dev.aherscu
Please read CONTRIBUTING.md for details on our process for submitting pull requests to us, and please ensure you follow the CODE_OF_CONDUCT.md.
This project is licensed under the Apache License - see the LICENSE file for details.
For validating published artifacts, use https://keys.openpgp.org/search?q=39F1B2495B0260B2D974C634F89B5DBA3AF082E0