Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Release/1.0 #1

Merged
merged 3 commits into from
Nov 27, 2023
Merged

Release/1.0 #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
743f70a
Add code checkout step to github release action
Nov 24, 2023
5468655
Adjust maven artifact name and release action name
Nov 27, 2023
59d9a2d
Adjust readme with installation instructions
Nov 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions .github/workflows/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

name: Release
name: Prepare Release Draft

on:
workflow_dispatch:
Expand All @@ -23,13 +23,17 @@ 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
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
44 changes: 43 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

<repositories>
<repository>
<id>local-repo</id>
<url>file:nonadobedependencies</url>
<name>Repository</name>
<releases>
<enabled>true</enabled>
<updatePolicy>never</updatePolicy>
</releases>
<snapshots>
<enabled>false</enabled>
</snapshots>
</repository>
</repositories>

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:

<dependency>
<groupId>com.valtech.aem</groupId>
<artifactId>msm-tools.all</artifactId>
<version>{version}</version>
<type>zip</type>
</dependency>

And including into the `embeddeds` definition of your `filevault-package-maven-plugin`:

<ebedded>
<groupId>com.valtech.aem</groupId>
<artifactId>msm-tools.all</artifactId>
<type>zip</type>
<target>{location of your other vendor packages under /apps}</target>
</ebedded>

## License

The SaaS AEM module is licensed under the [MIT LICENSE](LICENSE).
The AEM MSM Tools module is licensed under the [MIT LICENSE](LICENSE).
10 changes: 5 additions & 5 deletions all/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
<!-- ====================================================================== -->
<!-- P R O J E C T D E S C R I P T I O N -->
<!-- ====================================================================== -->
<artifactId>msm-tool.all</artifactId>
<artifactId>msm-tools.all</artifactId>
<packaging>content-package</packaging>
<name>MSM Tools - All</name>
<description>All content package for MSM Tools</description>
Expand All @@ -56,13 +56,13 @@
<embeddeds>
<embedded>
<groupId>com.valtech.aem</groupId>
<artifactId>msm-tool.ui.apps</artifactId>
<artifactId>msm-tools.ui.apps</artifactId>
<type>zip</type>
<target>/apps/valtech-msm-tools-packages/application/install</target>
</embedded>
<embedded>
<groupId>com.valtech.aem</groupId>
<artifactId>msm-tool.core</artifactId>
<artifactId>msm-tools.core</artifactId>
<target>/apps/valtech-msm-tools-packages/application/install</target>
</embedded>
</embeddeds>
Expand Down Expand Up @@ -168,13 +168,13 @@
<dependencies>
<dependency>
<groupId>com.valtech.aem</groupId>
<artifactId>msm-tool.ui.apps</artifactId>
<artifactId>msm-tools.ui.apps</artifactId>
<version>${project.version}</version>
<type>zip</type>
</dependency>
<dependency>
<groupId>com.valtech.aem</groupId>
<artifactId>msm-tool.core</artifactId>
<artifactId>msm-tools.core</artifactId>
<version>${project.version}</version>
</dependency>
</dependencies>
Expand Down
2 changes: 1 addition & 1 deletion core/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
<version>1.0.0-SNAPSHOT</version>
<relativePath>../pom.xml</relativePath>
</parent>
<artifactId>msm-tool.core</artifactId>
<artifactId>msm-tools.core</artifactId>
<name>MSM Tools - Core</name>
<description>Core bundle for MSM Tools</description>
<build>
Expand Down
2 changes: 1 addition & 1 deletion ui.apps.structure/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<!-- ====================================================================== -->
<!-- P R O J E C T D E S C R I P T I O N -->
<!-- ====================================================================== -->
<artifactId>msm-tool.ui.apps.structure</artifactId>
<artifactId>msm-tools.ui.apps.structure</artifactId>
<packaging>content-package</packaging>
<name>MSM Tools - Repository Structure Package</name>
<description>
Expand Down
10 changes: 5 additions & 5 deletions ui.apps/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
<!-- ====================================================================== -->
<!-- P R O J E C T D E S C R I P T I O N -->
<!-- ====================================================================== -->
<artifactId>msm-tool.ui.apps</artifactId>
<artifactId>msm-tools.ui.apps</artifactId>
<packaging>content-package</packaging>
<name>MSM Tool - UI apps</name>
<description>UI apps package for MSM Tools</description>
Expand All @@ -52,12 +52,12 @@
<cloudManagerTarget>none</cloudManagerTarget>
</properties>
<group>com.valtech.aem</group>
<name>msm-tool.ui.apps</name>
<name>msm-tools.ui.apps</name>
<packageType>application</packageType>
<repositoryStructurePackages>
<repositoryStructurePackage>
<groupId>com.valtech.aem</groupId>
<artifactId>msm-tool.ui.apps.structure</artifactId>
<artifactId>msm-tools.ui.apps.structure</artifactId>
</repositoryStructurePackage>
</repositoryStructurePackages>
<dependencies>
Expand Down Expand Up @@ -108,15 +108,15 @@
<dependencies>
<dependency>
<groupId>com.valtech.aem</groupId>
<artifactId>msm-tool.core</artifactId>
<artifactId>msm-tools.core</artifactId>
<version>${project.version}</version>
</dependency>



<dependency>
<groupId>com.valtech.aem</groupId>
<artifactId>msm-tool.ui.apps.structure</artifactId>
<artifactId>msm-tools.ui.apps.structure</artifactId>
<version>${project.version}</version>
<type>zip</type>
</dependency>
Expand Down