From 2c90f35142b0967a7e22e6687ebe8c10cd0087fa Mon Sep 17 00:00:00 2001 From: "A.Arnold" Date: Fri, 14 Mar 2025 14:29:09 +0000 Subject: [PATCH 1/4] MTA-4775: Effort differs between applications depending on whether they can be built or not Signed-off-by: A.Arnold --- docs/cli-guide/master.adoc | 7 +++++-- docs/topics/issues-with-report.adoc | 17 +++++++++++++++++ 2 files changed, 22 insertions(+), 2 deletions(-) create mode 100644 docs/topics/issues-with-report.adoc diff --git a/docs/cli-guide/master.adoc b/docs/cli-guide/master.adoc index 0c9b41d6..38685767 100644 --- a/docs/cli-guide/master.adoc +++ b/docs/cli-guide/master.adoc @@ -66,11 +66,11 @@ include::topics/mta-cli-run-single-app.adoc[leveloffset=+3] include::topics/mta-cli-run-multiple-apps.adoc[leveloffset=+3] +include::topics/proc_running-the-containerless-mta-cli.adoc[leveloffset=+3] + // Analyze application source code include::topics/mta-cli-analyze.adoc[leveloffset=+3] -include::topics/proc_running-the-containerless-mta-cli.adoc[leveloffset=+3] - // Transform XML rules to YAML include::topics/mta-cli-transform.adoc[leveloffset=+3] @@ -104,6 +104,9 @@ include::topics/mta-review-reports.adoc[leveloffset=+1] // Optimize {ProductShortName} Performance include::topics/mta-optimize-performance.adoc[leveloffset=+1] +// Issues with reports +include::topics/issues-with-report.adoc[leveloffset=+2] + // Configure {ProductShortName} to Exclude Files and Packages // include::topics/mta-exclude-files-and-packages.adoc[leveloffset=+2] diff --git a/docs/topics/issues-with-report.adoc b/docs/topics/issues-with-report.adoc new file mode 100644 index 00000000..09db58c7 --- /dev/null +++ b/docs/topics/issues-with-report.adoc @@ -0,0 +1,17 @@ +// Module included in the following assemblies: +// +// * docs/cli-guide/master.adoc + +:_content-type: CONCEPT +[id="issues-with-report_{context}"] += Issues with reports + +.Running {ProductShortName} on a project with an inaccessible parent pom.xml file may not result in a full analysis + +Running {ProductFullName} on a project with an inaccessible parent pom.xml file may not result in a full analysis. For example, this issue impacts the link:https://github.com/jboss-developer/jboss-eap-quickstarts/tree/EAP_7.4.0.GA[JBoss EAP Quickstarts], which demonstrate JBoss EAP, Jakarta EE 10, and other additional technologies. They provide small, specific, working examples that can be used as a reference for your project. However, these quickstarts specify a relative path to their parent POM file, which does not exist when the {ProductShortName} container is run. + +Specifying an input path of link:https://github.com/jboss-developer/jboss-eap-quickstarts/tree/EAP_7.4.0.GA/kitchensink[`kitchensink`] mounts the `kitchensink` directory as a volume in the container, but that means that the JDT Language Server (jdtls) is unable to access the parent link:https://github.com/jboss-developer/jboss-eap-quickstarts/blob/EAP_7.4.0.GA/kitchensink/pom.xml[pom.xml] file. + +This causes the jdtls to encounter a `Non-resolvable parent POM for org.jboss.eap.quickstarts:kitchensink:7.4.0.GA error` project build error. This error creates a `.project` file, which is missing the `org.eclipse.jdt.core.javanature`, meaning that jdtls, and subsequently {ProductShortName}, is unable to access details about the Java files. + +If you remove the parent pom.xml file and make the `kitchensink` project completely standalone, there are no issues. From 4d38360cb54c0c68b6f9c201e00d0e616a95c974 Mon Sep 17 00:00:00 2001 From: "A.Arnold" Date: Tue, 18 Mar 2025 23:05:18 +0000 Subject: [PATCH 2/4] add Signed-off-by: A.Arnold --- .github/workflows/build-asciidoc.yml | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 .github/workflows/build-asciidoc.yml diff --git a/.github/workflows/build-asciidoc.yml b/.github/workflows/build-asciidoc.yml new file mode 100644 index 00000000..61485b9f --- /dev/null +++ b/.github/workflows/build-asciidoc.yml @@ -0,0 +1,24 @@ +name: build adocs + +on: + push: + branches: + - master +jobs: + adoc_build: + runs-on: ubuntu-latest + name: Asciidoc build + steps: + - name: Checkout code + uses: actions/checkout@v2 + - name: Get build container + id: adocbuild + uses: tonynv/asciidoctor-action@master + with: + program: "asciidoctor -D docs -a stylesheet=style.css --backend=html5 -o index.html README.adoc && echo 'docs.upsilonproject.io' > docs/CNAME" + - name: Deploy docs to ghpages + uses: peaceiris/actions-gh-pages@v3 + with: + deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }} + publish_branch: gh-pages + publish_dir: ./docs/ \ No newline at end of file From 58bdae864ff471a8c4646aad59c9891538aae9d7 Mon Sep 17 00:00:00 2001 From: "A.Arnold" Date: Tue, 18 Mar 2025 23:09:26 +0000 Subject: [PATCH 3/4] Revert "MTA-4775: Effort differs between applications depending on whether they can be built or not" This reverts commit 2c90f35142b0967a7e22e6687ebe8c10cd0087fa. --- docs/cli-guide/master.adoc | 7 ++----- docs/topics/issues-with-report.adoc | 17 ----------------- 2 files changed, 2 insertions(+), 22 deletions(-) delete mode 100644 docs/topics/issues-with-report.adoc diff --git a/docs/cli-guide/master.adoc b/docs/cli-guide/master.adoc index 38685767..0c9b41d6 100644 --- a/docs/cli-guide/master.adoc +++ b/docs/cli-guide/master.adoc @@ -66,11 +66,11 @@ include::topics/mta-cli-run-single-app.adoc[leveloffset=+3] include::topics/mta-cli-run-multiple-apps.adoc[leveloffset=+3] -include::topics/proc_running-the-containerless-mta-cli.adoc[leveloffset=+3] - // Analyze application source code include::topics/mta-cli-analyze.adoc[leveloffset=+3] +include::topics/proc_running-the-containerless-mta-cli.adoc[leveloffset=+3] + // Transform XML rules to YAML include::topics/mta-cli-transform.adoc[leveloffset=+3] @@ -104,9 +104,6 @@ include::topics/mta-review-reports.adoc[leveloffset=+1] // Optimize {ProductShortName} Performance include::topics/mta-optimize-performance.adoc[leveloffset=+1] -// Issues with reports -include::topics/issues-with-report.adoc[leveloffset=+2] - // Configure {ProductShortName} to Exclude Files and Packages // include::topics/mta-exclude-files-and-packages.adoc[leveloffset=+2] diff --git a/docs/topics/issues-with-report.adoc b/docs/topics/issues-with-report.adoc deleted file mode 100644 index 09db58c7..00000000 --- a/docs/topics/issues-with-report.adoc +++ /dev/null @@ -1,17 +0,0 @@ -// Module included in the following assemblies: -// -// * docs/cli-guide/master.adoc - -:_content-type: CONCEPT -[id="issues-with-report_{context}"] -= Issues with reports - -.Running {ProductShortName} on a project with an inaccessible parent pom.xml file may not result in a full analysis - -Running {ProductFullName} on a project with an inaccessible parent pom.xml file may not result in a full analysis. For example, this issue impacts the link:https://github.com/jboss-developer/jboss-eap-quickstarts/tree/EAP_7.4.0.GA[JBoss EAP Quickstarts], which demonstrate JBoss EAP, Jakarta EE 10, and other additional technologies. They provide small, specific, working examples that can be used as a reference for your project. However, these quickstarts specify a relative path to their parent POM file, which does not exist when the {ProductShortName} container is run. - -Specifying an input path of link:https://github.com/jboss-developer/jboss-eap-quickstarts/tree/EAP_7.4.0.GA/kitchensink[`kitchensink`] mounts the `kitchensink` directory as a volume in the container, but that means that the JDT Language Server (jdtls) is unable to access the parent link:https://github.com/jboss-developer/jboss-eap-quickstarts/blob/EAP_7.4.0.GA/kitchensink/pom.xml[pom.xml] file. - -This causes the jdtls to encounter a `Non-resolvable parent POM for org.jboss.eap.quickstarts:kitchensink:7.4.0.GA error` project build error. This error creates a `.project` file, which is missing the `org.eclipse.jdt.core.javanature`, meaning that jdtls, and subsequently {ProductShortName}, is unable to access details about the Java files. - -If you remove the parent pom.xml file and make the `kitchensink` project completely standalone, there are no issues. From 2038af375b301926ccc59bbf3b5b389c6b3bba70 Mon Sep 17 00:00:00 2001 From: "A.Arnold" Date: Tue, 18 Mar 2025 23:14:37 +0000 Subject: [PATCH 4/4] add Signed-off-by: A.Arnold --- asciidoc-style.css | 94 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 94 insertions(+) create mode 100644 asciidoc-style.css diff --git a/asciidoc-style.css b/asciidoc-style.css new file mode 100644 index 00000000..d23c6cad --- /dev/null +++ b/asciidoc-style.css @@ -0,0 +1,94 @@ +body { + font-family: sans-serif; + line-height: 1.5; + padding: 0; + margin: 0; +} + +.article { + display: grid; + grid-template-areas: "nav content"; + grid-template-columns: 20em 1fr; + grid-template-rows: auto; +} + +a { + text-decoration: none; +} + +#header { + background-color: #444; + grid-area: nav; +} + +#toc { + padding: 1em; +} + +#toc a { + color: white; +} + +#toc li { + padding-bottom: .6em; +} + +#toc ul { + list-style: none; + margin: 0; + padding: 0; +} + +#toc ul ul { + padding-left: 1.4em; +} + +#toctitle { + font-weight: bold; + color: white; +} + +h1 { + font-size: 1.4em; + background-color: black; + padding: .6em; + margin: 0; + color: white; +} + +#toc a:hover { + background-color: maroon; +} + +#content { + background-color: white; + grid-area: content; + max-width: 1000px; + padding: 1em; + margin: auto; +} + +#content img { + max-width: 100%; +} + +pre { + background-color: #f7f7f8; + padding: 1em; + word-wrap: break-word; + white-space: pre-wrap; +} + +table { + border-collapse: collapse; +} + +td, th { + border: 1px solid gray; + padding: .4em; +} + +th { + background-color: #f9f9f9; + text-align: left; +}