Sen descrición

Oliver Drotbohm fe45e37619 GH-452 - Make SalespointWebSecurityConfiguration @ConditionalOnWebApplication. hai 11 meses
.github d35272e48a GH-425 - Minor infrastructure and readme cleanups. hai 1 ano
.mvn f7bf2794c7 GH-447 - Upgrade Maven wrapper. hai 1 ano
doc 4a027ae01e #385 - Changed spelling of cancelled to canceled. hai 1 ano
etc 22d0c2dfa1 #25 - Overhauled domain code. %!s(int64=10) %!d(string=hai) anos
src fe45e37619 GH-452 - Make SalespointWebSecurityConfiguration @ConditionalOnWebApplication. hai 11 meses
.gitignore fc2ddb5bed #361 - Add IntelliJ IDEA project files to .gitignore. %!s(int64=3) %!d(string=hai) anos
.sonarcloud.properties ea35458614 #317 - Add configuration for Sonarcloud. %!s(int64=4) %!d(string=hai) anos
LICENSE ccc8e807d9 #169 - Added license file to project root. %!s(int64=7) %!d(string=hai) anos
Salespoint.sonargraph 5450ed1889 #150 - Updated Sonargraph architecture description. %!s(int64=8) %!d(string=hai) anos
application.yml 49df4ffedb #331 - Added configuration to generate changelog for GitHub. %!s(int64=4) %!d(string=hai) anos
lombok.config ff9d07256f #328 - Renamed …Manager types to …Management. %!s(int64=4) %!d(string=hai) anos
mvnw f7bf2794c7 GH-447 - Upgrade Maven wrapper. hai 1 ano
mvnw.cmd f7bf2794c7 GH-447 - Upgrade Maven wrapper. hai 1 ano
pom.xml e7e16c7d22 GH-451 - Prepare next development iteration. hai 1 ano
readme.adoc d35272e48a GH-425 - Minor infrastructure and readme cleanups. hai 1 ano

readme.adoc

= Salespoint Framework

image:https://github.com/st-tu-dresden/salespoint/actions/workflows/deploy.yaml/badge.svg["Build and deploy Maven artifacts", link="https://github.com/st-tu-dresden/salespoint/actions/workflows/deploy.yaml"]

== Prerequisites

- OpenJDK 17
- Git

== Building the project

.Building the project
[source, bash]
----
$ git clone https://github.com/st-tu-dresden/salespoint
$ cd salespoint
$ ./mvnw clean install
----

== Documentation

The reference documentation is written in Asciidoc and built using Asciidoctor. The main documentation source file is located in `src/main/asciidoc`.

To build the reference documentation simply run `./mvnw -Pdocs package` on the command line. This generates the following HTML files:

* the Salespoint website in `target/generated-docs/index.html`.
* the Salespoint reference in `target/generated-docs/salespoint-reference.html`.

== Deployment

To deploy artifacts to the salespoint repository, simply run `./mvnw clean deploy`. This requires your `settings.xml` (located in `~/.m2` ) to contain a server definition with the credentials to access the Salespoint server via SFTP:

[source, xml]
----

salespoint



----

To deploy the website and reference documentation, run `./mvnw -Pdocs site:deploy`.

== Release

1. Make sure all tickets are closed, except the release one.
2. Tweak `ChangelogCreator` (in `src/test/java`) to point to the milestone to be released. Run the creator. Copy console output into `src/main/asciidoc/site/changelog.adoc`.
3. Update version information `index.adoc` (in `src/main/asciidoc/site`).
4. Commit as `GH-??? - Prepare release $version.`. If this was on a maintainance branch, also cherry-pick this commit to `main` and resolve any conflicts.
5. Run `./mvnw release:prepare`.
6. Edit commits to match commit message format, re-create tag.
7. Push changes & tag.
8. Check out tag and run `./mvnw clean deploy -Prelease -DskipTests`.
9. Check out tag and run `./mvnw clean package site:deploy -Pdocs,release`.