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

Update workflows and docs generation. #141

Merged
merged 1 commit into from
Mar 1, 2022
Merged

Update workflows and docs generation. #141

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 2 additions & 5 deletions .github/workflows/changelog.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,12 @@
name: Update Changelog

concurrency: ci-modernize-tools-metadata

on:
push:
branches:
- main
workflow_dispatch:
workflow_run:
workflows: ["Tag & Release"]
branches: [main]
types:
- completed

jobs:
changelog:
Expand Down
22 changes: 15 additions & 7 deletions .github/workflows/javadocs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,27 @@
name: Update JavaDocs

concurrency: ci-modernize-tools-metadata

on:
push:
tags:
- aem-modernize-tools-*
workflow_dispatch:
workflow_run:
workflows: ["Update JavaDocs"]
branches: [main]
types:
- completed

jobs:
job
generate-javadocs:
runs-on: ubuntu-latest
if: (!github.event.workflow_run || github.event.workflow_run.conclusion == 'success') && github.repository == 'adobe/aem-modernize-tools' && github.ref == 'refs/heads/main'
if: github.repository == 'adobe/aem-modernize-tools'

steps:
- name: Checkout tag
uses: actions/checkout@v2

- name: Store Version
id: store-version
run: echo "::set-output name=version::$(mvn -q help:evaluate -Dexpression=project.version -DforceStdout)"

- name: Checkout code
uses: actions/checkout@v2
with:
Expand All @@ -27,7 +35,7 @@ jobs:
cache: maven

- name: Build JavaDocs
run: mvn clean process-resources -Pgenerate-site-docs,aemCloudService -pl .,core
run: mvn clean process-resources -Pgenerate-site-docs,aemCloudService -pl .,core -Dproject.version=${{ steps.store-version.outputs.version }}

- name: Commit Docs
run: |
Expand Down
34 changes: 34 additions & 0 deletions core/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -337,6 +337,40 @@ Bundle-SymbolicName: com.adobe.aem.aem-modernize-tools.core
</dependency>
</dependencies>
</profile>
<profile>
<id>generate-site-docs</id>
<activation>
<activeByDefault>false</activeByDefault>
</activation>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-clean-plugin</artifactId>
<version>3.1.0</version>
<configuration>
<directory>docs/_apidocs</directory>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<executions>
<execution>
<id>attach-javadoc</id>
<phase>process-resources</phase>
<goals>
<goal>javadoc</goal>
</goals>
<configuration>
<reportOutputDirectory>${maven.multiModuleProjectDirectory}/docs/_apidocs</reportOutputDirectory>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
</profile>
</profiles>

<dependencies>
Expand Down
24 changes: 0 additions & 24 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1085,30 +1085,6 @@ Bundle-DocURL:
</activation>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-clean-plugin</artifactId>
<version>3.1.0</version>
<configuration>
<directory>docs/_apidocs</directory>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<executions>
<execution>
<id>attach-javadoc</id>
<phase>process-resources</phase>
<goals>
<goal>javadoc</goal>
</goals>
<configuration>
<reportOutputDirectory>${maven.multiModuleProjectDirectory}/docs/_apidocs</reportOutputDirectory>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-resources-plugin</artifactId>
Expand Down
8 changes: 5 additions & 3 deletions src/docs/resources/_pages/plan-operate/set-up.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ The AEM Modernize Tools has multiple distributions; the following are available

### Step 2: Add as an Embed/Sub package

For more information on the Maven Project sructural changes in Maven Archetype 21, please review [Understand the Structure of a Project Content Package in AEM as a Cloud Service](https://docs.adobe.com/content/help/en/experience-manager-cloud-service/implementing/developing/aem-project-content-package-structure.html). Note that this project structure is compatible with AEM 6.x as well.
For more information on the Maven Project structural changes in Maven Archetype 21, please review [Understand the Structure of a Project Content Package in AEM as a Cloud Service](https://docs.adobe.com/content/help/en/experience-manager-cloud-service/implementing/developing/aem-project-content-package-structure.html). Note that this project structure is compatible with AEM 6.x as well.

In the `filevault-package-maven-plugin` configuration of your all project’s pom.xml file, add this:

Expand All @@ -64,18 +64,20 @@ In the `filevault-package-maven-plugin` configuration of your all project’s po
<embeddeds>
<embedded>
<groupId>com.adobe.aem</groupId>
<artifactId>aem-modernize-tools.ui.all</artifactId>
<artifactId>aem-modernize-tools.all</artifactId>
<type>zip</type>
<!-- <classifier>java8</classifier> optional, see above -->
<target>/apps/my-app-packages/application/install</target>
</embedded>
<embedded>
...
</plugin>
</plugins>
{% endhighlight %}

### Step 3: Add Bundle as a Dependency (Optional)

If you plan to create custom implementations of the `RewriteRule` interface, your bundle project will need to add a dependency to the bundle artifact of this project. This can be done by adding this to the your dependency list:
If you plan to create custom implementations of the `RewriteRule` interface, your bundle project will need to add a dependency to the bundle artifact of this project. This can be done by adding this to your dependency list:

{% highlight xml %}
<dependency>
Expand Down