Skip to content

Commit

Permalink
feat: 🚀 upgrade gherkin version support, manage latest syntax (#112)
Browse files Browse the repository at this point in the history
* feat: 🚀 upgrade gherkin version support, manage latest syntax

* feat: 🚀 upgrade gherkin version support, manage latest syntax

* chore: 💚 remove java 11 support

* chore: 💚 restore java 11 support

* support java 11

---------

Co-authored-by: Julien Boz <[email protected]>
  • Loading branch information
jboz and Julien Boz authored Feb 8, 2024
1 parent 121658b commit 5710d2a
Show file tree
Hide file tree
Showing 136 changed files with 13,885 additions and 5,917 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/build-and-deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ name: Build and Deploy

on:
push:
branches: [ master ]
branches: [master]
pull_request:
branches: [ master ]
branches: [master]
workflow_dispatch:

env:
Expand Down Expand Up @@ -156,7 +156,7 @@ jobs:
if: "needs.check.outputs.plugin-status == 'deploy' && github.event_name == 'pull_request'"
strategy:
matrix:
version: [ 11, 15, 17 ]
version: [11, 15, 17]
env:
folder: livingdoc-examples
steps:
Expand Down
36 changes: 17 additions & 19 deletions livingdoc-annotations/pom.xml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>

<groupId>ch.ifocusit.livingdoc</groupId>
Expand All @@ -11,7 +11,7 @@
<name>Living Documentation annotations</name>
<description>Annotations to help the generation of a nice living documentation by mark some part of the source code.</description>
<url>https://github.com/jboz/living-documentation</url>
<inceptionYear>2023</inceptionYear>
<inceptionYear>2024</inceptionYear>

<organization>
<name>Focus IT</name>
Expand Down Expand Up @@ -61,7 +61,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.11.0</version>
<version>3.12.1</version>
</plugin>
</plugins>
</build>
Expand All @@ -71,7 +71,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-project-info-reports-plugin</artifactId>
<version>3.4.1</version>
<version>3.5.0</version>
<reportSets>
<reportSet>
<reports>
Expand All @@ -90,7 +90,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.4.1</version>
<version>3.6.3</version>
<reportSets>
<reportSet>
<reports>
Expand All @@ -102,11 +102,9 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-report-plugin</artifactId>
<version>2.22.2</version>
<version>3.2.5</version>
<configuration>
<showSuccess>
true
</showSuccess>
<showSuccess>true</showSuccess>
</configuration>
</plugin>
</plugins>
Expand All @@ -133,10 +131,10 @@
</properties>
<build>
<plugins>
<plugin><!-- create source artifact -->
<plugin> <!-- create source artifact -->
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-source-plugin</artifactId>
<version>3.0.1</version>
<version>3.3.0</version>
<executions>
<execution>
<id>attach-sources</id>
Expand All @@ -146,10 +144,10 @@
</execution>
</executions>
</plugin>
<plugin><!-- create javadoc artifact -->
<plugin> <!-- create javadoc artifact -->
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.5.0</version>
<version>3.6.3</version>
<executions>
<execution>
<id>attach-javadocs</id>
Expand All @@ -159,10 +157,10 @@
</execution>
</executions>
</plugin>
<plugin><!-- Sign artifact -->
<plugin> <!-- Sign artifact -->
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-gpg-plugin</artifactId>
<version>3.0.1</version>
<version>3.1.0</version>
<executions>
<execution>
<id>sign-artifacts</id>
Expand All @@ -173,9 +171,9 @@
</execution>
</executions>
</plugin>
<plugin><!-- create project artifact -->
<plugin> <!-- create project artifact -->
<artifactId>maven-release-plugin</artifactId>
<version>3.0.0</version>
<version>3.0.1</version>
<configuration>
<tagNameFormat>v@{project.version}</tagNameFormat>
<allowTimestampedSnapshots>true</allowTimestampedSnapshots>
Expand All @@ -196,7 +194,7 @@
<updateReleaseInfo>true</updateReleaseInfo>
</configuration>
</plugin>
<plugin><!-- Release dist files to maven central -->
<plugin> <!-- Release dist files to maven central -->
<groupId>org.sonatype.plugins</groupId>
<artifactId>nexus-staging-maven-plugin</artifactId>
<version>1.6.13</version>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* Living Documentation
*
* Copyright (C) 2023 Focus IT
* Copyright (C) 2024 Focus IT
*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
Expand Down Expand Up @@ -31,6 +31,6 @@
* @author Julien Boz
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.PACKAGE})
@Target({ ElementType.PACKAGE })
public @interface BoundaryContext {
}
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* Living Documentation
*
* Copyright (C) 2023 Focus IT
* Copyright (C) 2024 Focus IT
*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
Expand Down Expand Up @@ -31,6 +31,6 @@
* @author Julien Boz
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.PACKAGE})
@Target({ ElementType.PACKAGE })
public @interface CoreDomain {
}
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* Living Documentation
*
* Copyright (C) 2023 Focus IT
* Copyright (C) 2024 Focus IT
*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
Expand Down Expand Up @@ -31,6 +31,6 @@
* @author Julien Boz
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.FIELD, ElementType.METHOD})
@Target({ ElementType.TYPE, ElementType.FIELD, ElementType.METHOD })
public @interface RootAggregate {
}
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* Living Documentation
*
* Copyright (C) 2023 Focus IT
* Copyright (C) 2024 Focus IT
*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
Expand Down Expand Up @@ -31,7 +31,7 @@
* @author Julien Boz
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.FIELD, ElementType.METHOD})
@Target({ ElementType.TYPE, ElementType.FIELD, ElementType.METHOD })
public @interface UbiquitousLanguage {

/**
Expand Down
7 changes: 3 additions & 4 deletions livingdoc-examples/aggregate/aggregate-zz-livingdoc/pom.xml
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://maven.apache.org/POM/4.0.0"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
xmlns="http://maven.apache.org/POM/4.0.0" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>

<parent>
Expand Down Expand Up @@ -84,12 +83,12 @@
<dependency>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctor-maven-plugin</artifactId>
<version>2.2.3</version>
<version>2.2.5</version>
</dependency>
<dependency>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctorj-diagram</artifactId>
<version>2.2.7</version>
<version>2.2.14</version>
</dependency>
<dependency>
<groupId>org.apache.maven.doxia</groupId>
Expand Down
3 changes: 1 addition & 2 deletions livingdoc-examples/aggregate/pom.xml
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://maven.apache.org/POM/4.0.0"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
xmlns="http://maven.apache.org/POM/4.0.0" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>

<parent>
Expand Down
4 changes: 2 additions & 2 deletions livingdoc-examples/ddd-annotated/pom.xml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>

<parent>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* Living Documentation
*
* Copyright (C) 2023 Focus IT
* Copyright (C) 2024 Focus IT
*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* Living Documentation
*
* Copyright (C) 2023 Focus IT
* Copyright (C) 2024 Focus IT
*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* Living Documentation
*
* Copyright (C) 2023 Focus IT
* Copyright (C) 2024 Focus IT
*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* Living Documentation
*
* Copyright (C) 2023 Focus IT
* Copyright (C) 2024 Focus IT
*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* Living Documentation
*
* Copyright (C) 2023 Focus IT
* Copyright (C) 2024 Focus IT
*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* Living Documentation
*
* Copyright (C) 2023 Focus IT
* Copyright (C) 2024 Focus IT
*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* Living Documentation
*
* Copyright (C) 2023 Focus IT
* Copyright (C) 2024 Focus IT
*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* Living Documentation
*
* Copyright (C) 2023 Focus IT
* Copyright (C) 2024 Focus IT
*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
Expand Down
21 changes: 11 additions & 10 deletions livingdoc-examples/ddd/pom.xml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>

<parent>
Expand Down Expand Up @@ -36,7 +36,7 @@
<dependency>
<groupId>javax.validation</groupId>
<artifactId>validation-api</artifactId>
<version>2.0.0.Final</version>
<version>2.0.1.Final</version>
</dependency>
</dependencies>

Expand All @@ -49,7 +49,7 @@
<executions>
<execution>
<id>all</id>
<phase>package</phase><!-- default phase -->
<phase>package</phase> <!-- default phase -->
<goals>
<goal>diagram</goal>
<goal>glossary</goal>
Expand All @@ -67,17 +67,18 @@
</excludes>
<diagramTitle>= Classes Diagram</diagramTitle>
<diagramLinkPage>Glossary</diagramLinkPage>
<diagramAsPlantumlMacro>true</diagramAsPlantumlMacro><!-- this will result as the use of the plantuml macro in confluence: https://marketplace.atlassian.com/apps/41025/plantuml-for-confluence -->
<diagramAsPlantumlMacro>true</diagramAsPlantumlMacro> <!-- this will result as the use of the plantuml macro in confluence: https://marketplace.atlassian.com/apps/41025/plantuml-for-confluence -->
<dictionaryTitle>= Dictionary</dictionaryTitle>
<glossaryTitle>= Glossary</glossaryTitle>
<gherkinTitle>= Use Case - Invoice management - </gherkinTitle><!-- will be used as a prefix for the confluence page name -->
<gerkinSeparateFeature>true</gerkinSeparateFeature><!-- set false to merge all feature into one page, default is true -->
<format>adoc</format><!-- adoc output format is mandatory for confluence publisher because it doesn't allow to publish full html page -->
<gherkinTitle>= Use Case - Invoice management - </gherkinTitle> <!-- will be used as a prefix for the confluence page name -->
<gerkinSeparateFeature>true</gerkinSeparateFeature> <!-- set false to merge all feature into one page, default is true -->
<gherkinOptions>withoutTitle=true,withChildSeparator=true</gherkinOptions>
<format>adoc</format>
<publish>
<provider>confluence</provider><!-- actually only confluence is supported -->
<provider>confluence</provider> <!-- actually only confluence is supported -->
<endpoint>${CONFLUENCE_URL}</endpoint>
<spaceKey>DOCPROD</spaceKey>
<ancestorId>98369</ancestorId><!-- parent pageId -->
<ancestorId>98369</ancestorId> <!-- parent pageId -->
<username>livingdoc</username>
<password>livingdoc</password>
</publish>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* Living Documentation
*
* Copyright (C) 2023 Focus IT
* Copyright (C) 2024 Focus IT
*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* Living Documentation
*
* Copyright (C) 2023 Focus IT
* Copyright (C) 2024 Focus IT
*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
Expand Down
Loading

0 comments on commit 5710d2a

Please sign in to comment.