From 743f70a80f719297893c5d8a651416e5239803f0 Mon Sep 17 00:00:00 2001 From: Renaldas Szentiks Date: Fri, 24 Nov 2023 15:38:35 +0100 Subject: [PATCH 1/3] Add code checkout step to github release action --- .github/workflows/release.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 4504ab8..ad79176 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -23,6 +23,10 @@ jobs: if: startsWith(github.ref, 'refs/heads/release/') runs-on: ubuntu-latest steps: + - name: Checkout code + uses: actions/checkout@v3 + with: + fetch-depth: '0' - name: Download Package / Artifact if: ${{ inputs.releaseVersion != '' }} uses: actions/download-artifact@v3 From 5468655b836200803407b73e355604c0627eae39 Mon Sep 17 00:00:00 2001 From: Renaldas Szentiks Date: Mon, 27 Nov 2023 11:11:10 +0100 Subject: [PATCH 2/3] Adjust maven artifact name and release action name --- .github/workflows/release.yml | 4 ++-- all/pom.xml | 10 +++++----- core/pom.xml | 2 +- ui.apps.structure/pom.xml | 2 +- ui.apps/pom.xml | 10 +++++----- 5 files changed, 14 insertions(+), 14 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index ad79176..f12db10 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -1,5 +1,5 @@ -name: Release +name: Prepare Release Draft on: workflow_dispatch: @@ -33,7 +33,7 @@ jobs: with: name: 'aem-msm-tools-${{ inputs.releaseVersion }}' path: ./artifacts - - name: Create Github Release + - name: Create Github Release Draft env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} run: gh release create ${{ inputs.releaseVersion }} --draft --generate-notes --title ${{ inputs.releaseVersion }} ./artifacts/*.zip diff --git a/all/pom.xml b/all/pom.xml index fdae700..aed4e03 100644 --- a/all/pom.xml +++ b/all/pom.xml @@ -31,7 +31,7 @@ - msm-tool.all + msm-tools.all content-package MSM Tools - All All content package for MSM Tools @@ -56,13 +56,13 @@ com.valtech.aem - msm-tool.ui.apps + msm-tools.ui.apps zip /apps/valtech-msm-tools-packages/application/install com.valtech.aem - msm-tool.core + msm-tools.core /apps/valtech-msm-tools-packages/application/install @@ -168,13 +168,13 @@ com.valtech.aem - msm-tool.ui.apps + msm-tools.ui.apps ${project.version} zip com.valtech.aem - msm-tool.core + msm-tools.core ${project.version} diff --git a/core/pom.xml b/core/pom.xml index ce4e744..30db0d3 100644 --- a/core/pom.xml +++ b/core/pom.xml @@ -23,7 +23,7 @@ 1.0.0-SNAPSHOT ../pom.xml - msm-tool.core + msm-tools.core MSM Tools - Core Core bundle for MSM Tools diff --git a/ui.apps.structure/pom.xml b/ui.apps.structure/pom.xml index c917ff3..dd54423 100644 --- a/ui.apps.structure/pom.xml +++ b/ui.apps.structure/pom.xml @@ -15,7 +15,7 @@ - msm-tool.ui.apps.structure + msm-tools.ui.apps.structure content-package MSM Tools - Repository Structure Package diff --git a/ui.apps/pom.xml b/ui.apps/pom.xml index 116af84..0cd9056 100644 --- a/ui.apps/pom.xml +++ b/ui.apps/pom.xml @@ -30,7 +30,7 @@ - msm-tool.ui.apps + msm-tools.ui.apps content-package MSM Tool - UI apps UI apps package for MSM Tools @@ -52,12 +52,12 @@ none com.valtech.aem - msm-tool.ui.apps + msm-tools.ui.apps application com.valtech.aem - msm-tool.ui.apps.structure + msm-tools.ui.apps.structure @@ -108,7 +108,7 @@ com.valtech.aem - msm-tool.core + msm-tools.core ${project.version} @@ -116,7 +116,7 @@ com.valtech.aem - msm-tool.ui.apps.structure + msm-tools.ui.apps.structure ${project.version} zip From 59d9a2d1b71887eb1024259a71ccc02b271f152b Mon Sep 17 00:00:00 2001 From: Renaldas Szentiks Date: Mon, 27 Nov 2023 11:22:48 +0100 Subject: [PATCH 3/3] Adjust readme with installation instructions --- README.md | 44 +++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 43 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e85f3bf..c1f829c 100644 --- a/README.md +++ b/README.md @@ -156,6 +156,48 @@ test, execute: mvn clean test +### Embedding Into Existing Projects + +You can embed this tool into other projects by creating a local maven repo in your project by adding the following +repo definition in your main POM: + + + + local-repo + file:nonadobedependencies + Repository + + true + never + + + false + + + + +Afterwards, download the desired release package and execute the following command: + + mvn install:install-file -Dfile={downloaded package file} -DgroupId=com.valtech.aem -DartifactId=msm-tools.all -Dversion={version} -Dpackaging=zip -DlocalRepositoryPath=./nonadobedependencies + +The last step is to include the package as a dependency in your `all` package, by using the dependency definition: + + + com.valtech.aem + msm-tools.all + {version} + zip + + +And including into the `embeddeds` definition of your `filevault-package-maven-plugin`: + + + com.valtech.aem + msm-tools.all + zip + {location of your other vendor packages under /apps} + + ## License -The SaaS AEM module is licensed under the [MIT LICENSE](LICENSE). \ No newline at end of file +The AEM MSM Tools module is licensed under the [MIT LICENSE](LICENSE). \ No newline at end of file