Compare commits

...

3 Commits

Author SHA1 Message Date
7c42f3b0c9 sqdfqsdf 2024-11-06 17:04:14 +01:00
ac4cd1c1cd juste un pr de test 2024-11-06 17:01:04 +01:00
f1636ec942 [FEAT] add workflow 2024-11-06 16:59:25 +01:00
4 changed files with 18 additions and 140 deletions

View File

@ -1,9 +1,9 @@
---
name: "Assign PR Author as Assignee"
"on":
on:
pull_request:
types: [opened, ready_for_review, reopened]
types: [opened]
jobs:
assign-pr-author-as-assignee:

16
.github/workflows/check-title.yml vendored Normal file
View File

@ -0,0 +1,16 @@
---
name: "Check PR title"
on:
pull_request:
types: [opened, edited, synchronize, ready_for_review, reopened]
jobs:
check-title:
runs-on: ubuntu-latest
steps:
- name: "Check title"
uses: Slashgear/action-check-pr-title@v4.3.0
with:
regexp: "\\[(API,)?(DEV-OPS|DOC|FEAT|FIX|FIX\\-CI|STYLE)\\][A-Za-z0-9 ,.'\\-!]+$"
helpMessage: "Title of the PR MUST respect format: \"[{TYPE}] clear description without typos in english\" with {TYPE}: <br/>[API] Change API that permit to access on the application (un-compatibility only). This one can specifically added with [API,{TYPE}]<br/>[DEV-OPS] Update automatic build system, method to deliver application/packages, ...<br/>[DOC] Update or add some documentation.<br/>[FEAT] Develop a new feature<br/>[FIX] When fixing issue<br/>[FIX-CI] When the CI fail to build and we apply a correction to set it work again.<br/>[STYLE] Update of the style tools/checker, or add/remove rules."

View File

@ -12,7 +12,6 @@ on:
push:
branches: [ "develop" ]
pull_request:
branches: [ "develop" ]
jobs:
build:

137
README.md
View File

@ -1,137 +0,0 @@
Archi-data
==========
Archi-data is a framework that simplify:
- Creating a REST server with:
- Right control
- Swagger display interface
- Normalize error generate by the server
- Access to the DB:
- introspect Object and insert in the TD (SQLITE & MY-SQL)
- Manage migration
- JPA checker for many generic request
- simplify the request of the Test-service
Develop in cmd-line:
--------------------
The first step is configuring your JAVA version (or select the JVM with the OS)
```bash
export PATH=$(ls -d --color=never /usr/lib/jvm/java-2*-openjdk)/bin:$PATH
```
Install the dependency:
```bash
mvn install
```
Run the test
```bash
mvn test
```
Install it for external use
```bash
mvn install
```
Develop With Eclipse:
--------------------
Import the project:
- Open a (new) project on eclipse
- `File` -> `Import`
- `Maven` -> `Existing Maven project`
- Select the `pom.xml` file and click on import
Run the Test:
- Open the package `test.kar.archidata`
- Click right on it
- Select `Debug As` -> `JUnit Test`
Install in the local maven repository:
- Click right on the `pom.xml` file
- Select `Run As` -> `Maven install`
Somes tools:
============
Auto-update dependency:
-----------------------
Auto-update to the last version dependency:
```bash
mvn versions:use-latest-versions
```
Format the code
---------------
Simply run the cmd-line:
```bash
mvn formatter:format
```
Reformat XML file like the pom.xml
```bash
XMLLINT_INDENT=" " xmllint --format "back/pom.xml" -o "back/pom.xml"
```
Enable the pre-commit checker
-----------------------------
```bash
./tools/configure_precommit.bash
```
> **_Note_**: You can change the code in `.git/hooks/pre-commit` by replacing `formatter:verify` with `formatter:format` to auto format the code @ every commit
Run Spot-bug:
------------
```bash
mvn spotbugs:check
```
Add Gitea in the dependency for the registry:
=============================================
Read instruction for tocken in ~/.m2/setting.xml
edit file: ```~/.m2/settings.xml```
```xml
<settings>
<servers>
<server>
<id>gitea</id>
<configuration>
<httpHeaders>
<property>
<name>Authorization</name>
<value>token xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx</value>
</property>
</httpHeaders>
</configuration>
</server>
</servers>
</settings>
```
release:
========
```bash
export PATH=$(ls -d --color=never /usr/lib/jvm/java-2*-openjdk)/bin:$PATH
mvn install
mvn deploy
```