Unverified Commit b1139739 authored by Andrea Ligios's avatar Andrea Ligios Committed by GitHub
Browse files

SDK 4.3 (#626)



* Improved the readability of the pom.xml

* Introduced 7.1 + upgrade others to the latest version

* Handled the new Share's versions separation

* Use a variable to set the user in the Dockerfile

* Final versions

* Updated README [ci skip]

* Fixed the broken URL to the new one

* Wildcard on the version to prevent further useless updates

Co-authored-by: default avatargfertuso <giovanni.fertuso@alfresco.com>
parent 21938919
Loading
Loading
Loading
Loading
+11 −1
Original line number Diff line number Diff line
@@ -35,6 +35,16 @@ jobs:
      script: 
        - ${MAVEN_INSTALL_CMD}

    - name: "7.1 Enterprise"
      stage: test
      script:
        - ${MAVEN_INSTALL_CMD} -Penterprise-71-tests

    - name: "7.1 Community"
      stage: test
      script:
        - ${MAVEN_INSTALL_CMD} -Pcommunity-71-tests

    - name: "7.0 Enterprise"
      stage: test
      script:
+40 −6
Original line number Diff line number Diff line
@@ -15,6 +15,7 @@ If you are an Enterprise customer check the [Support](#alfresco-enterprise-custo

## News

- 2021-10: Alfresco SDK 4.3.0 released
- 2021-02: Alfresco SDK 4.2.0 released
- 2019-10: Alfresco SDK 4.1.0 released
- 2019-03: Alfresco SDK 4.0.0 released
@@ -31,18 +32,50 @@ If you are an Enterprise customer check the [Support](#alfresco-enterprise-custo

## User Getting Started

### Important Notice about ACS 7.1 

#### Share Version Number

Since ACS 7.1, Share build pipeline has been refactored, and you now have to specify the internal 
Share version number, in addition to the version of the image, because they are not the same anymore.

This number can be located in the main pom.xml of the project used to build Share, hence: 

- property `<alfresco-community-share.version>` of [acs-community-packaging](https://github.com/Alfresco/acs-community-packaging/blob/7.1.0/pom.xml#L17) (Community)  
- property `<alfresco-enterprise-share.version>`of [acs-packaging](https://github.com/Alfresco/acs-packaging/blob/7.1.0.1/pom.xml#L18) (Enterprise) 

So, if for example you want to use the community version of `7.1.0.1`, you can go on acs-community-packaging, 
open the `7.1.0.1` release tag, browse its files, open the pom.xml in the root, 
then copy the value of `<alfresco-community-share.version>`. 

You'll then need to paste this value inside the SDK property `<alfresco.share.version>`.

#### Alternate Docker User

- ACS 6 used to run everything as `root`.
- ACS 7 introduced an `alfresco` user, that should've been used after the `root` user completed its configurations in the Dockerfile.

Due to a bug, this wasn't working in earlier SDKs, and has been fixed in SDK 4.3.

In order to be retro-compatible with ACS 6, however, the user is specified in the SDK property `<alfresco.platform.docker.user>`.

Hence, its values (already in place) are `root` for ACS 6, and `alfresco` for ACS 7+.

#### Log file location

To prevent writing permission problems when logging with the non-root user, 
the `alfresco.log` file has also been moved to a more appropriate location (Tomcat logs instead of Tomcat root).

### Important Notice about Version Numbers

In Q4 2020, Alfresco Platform has undergone a major structural refactoring.

Depending on the Platform version desired, you might need to use SDK 4.1 instead of SDK 4.2.
Depending on the Platform version desired, you might need to use SDK 4.1 instead of SDK 4.3.

- For Enterprise and Community versions of 7.x, SDK 4.2 must be used
- For Enterprise versions of 6.0.x, 6.1.x, 6.2.x newer than November 2020, SDK 4.2 must be used
- For Enterprise and Community versions of 7.x, SDK 4.3 must be used
- For Enterprise versions of 6.0.x, 6.1.x, 6.2.x newer than November 2020, SDK 4.3 must be used
- For Enterprise and Community versions of 6.0.x, 6.1.x, 6.2.x older than November 2020, SDK 4.1 must be used

A more precise compatibility matrix, with specific version numbers, is expected to be provided soon.

It's also important to remember that:

- Community Platform versions are built by [acs-community-packaging](https://github.com/Alfresco/acs-community-packaging)
@@ -51,11 +84,12 @@ It's also important to remember that:
- Enterprise Docker images are published on *Quay.io*

### Latest Documentation
To get started with **Alfresco SDK 4.2.x** (latest) visit the [Alfresco Documentation](docs/README.md).
To get started with **Alfresco SDK 4.3.x** (latest) visit the [Alfresco Documentation](docs/README.md).

#### Documentation about Previous Versions
| SDK Version  | Alfresco Enterprise Version       |  Alfresco Community Version       | Documentation  |
| ------------- |:-------------:| :-----:|:-----|
| SDK 4.3   | Alfresco 6.0.x / 6.1.x / 6.2.x / 7.0.x / 7.1.x | Alfresco 7.0.x / Alfresco 7.1.x | https://github.com/Alfresco/alfresco-sdk/tree/master/docs/README.md |
| SDK 4.2   | Alfresco 6.0.x / 6.1.x / 6.2.x / 7.0.x | Alfresco 7.0.x | https://github.com/Alfresco/alfresco-sdk/tree/master/docs/README.md |
| SDK 4.1   | Alfresco 6.0.x / 6.1.x / 6.2.x | Alfresco 6.0.x / 6.1.x / 6.2.x | https://github.com/Alfresco/alfresco-sdk/blob/sdk-4.1/docs/README.md |
| SDK 4.0   | Alfresco 6.0.x / 6.1.x | Alfresco 6.0.x / 6.1.x | https://github.com/Alfresco/alfresco-sdk/blob/sdk-4.0/docs/README.md |
+2 −2
Original line number Diff line number Diff line
# Alfresco AIO Project - SDK 4.2
# Alfresco AIO Project - SDK 4.3

This is an All-In-One (AIO) project for Alfresco SDK 4.2.
This is an All-In-One (AIO) project for Alfresco SDK 4.3.

Run with `./run.sh build_start` or `./run.bat build_start` and verify that it

+1 −1
Original line number Diff line number Diff line
@@ -4,7 +4,7 @@
    <modelVersion>4.0.0</modelVersion>
    <artifactId>${artifactId}</artifactId>
    <name>Integration Tests Module</name>
    <description>Integration Tests module for in-container integration testing - part of AIO - SDK 4.2</description>
    <description>Integration Tests module for in-container integration testing - part of AIO - SDK 4.3</description>
    <packaging>jar</packaging> <!-- Note. this just runs Integration Tests, but it needs to be a JAR otherwise
                                            nothing is compiled (i.e. you cannot set it to pom) -->

+1 −0
Original line number Diff line number Diff line
FROM ${docker.acs.image}:${alfresco.platform.version}

ARG TOMCAT_DIR=/usr/local/tomcat
ARG USERNAME=${alfresco.platform.docker.user} 

USER root

Loading