Unverified Commit 8fe7e1ec authored by Debjit Chattopadhyay's avatar Debjit Chattopadhyay Committed by GitHub
Browse files

[MNT-25505] update alfresco-sdk docs for 4.12.0 (#736)

parent 2496408a

README.md

+25 −23
Original line number Diff line number Diff line
@@ -14,6 +14,7 @@ This project is released under the [Apache License, Version 2.0](http://www.apac 
If you are an Enterprise customer check the [Support](#alfresco-enterprise-customers-and-partners-support) section.



## News

- 2025-07: Alfresco SDK 4.12.0 released

- 2025-03: Alfresco SDK 4.11.0 released

- 2024-11: Alfresco SDK 4.10.0 released

- 2024-08: Alfresco SDK 4.9.0 released
@@ -81,7 +82,7 @@ the `alfresco.log` file has also been moved to a more appropriate location (Tomc 


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, 4.3, 4.4, 4.5, 4.6, 4.7, 4.8, 4.9 or SDK 4.10 instead of SDK 4.11.0.

Depending on the Platform version desired, you might need to use SDK 4.1, 4.3, 4.4, 4.5, 4.6, 4.7, 4.8, 4.9, 4.10 or SDK 4.11 instead of SDK 4.12.0.



- For Enterprise and Community versions of 7.x, SDK 4.4 or higher 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
@@ -99,7 +100,8 @@ To get started with **Alfresco SDK 4.9.x** (latest) visit the [Alfresco Document 


#### Documentation about Previous Versions

| SDK Version |                                     Alfresco Enterprise Version                                     |                                     Alfresco Community Version                                      | Documentation                                                                                                                                                                                                   |

|---------------|:------------------------------------------------------------------------------------------:|:----------------------------------------------------------------------------------:|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

|-------------|:---------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------------------:|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

| SDK 4.12.0  | Alfresco 7.0.x / 7.1.x / 7.2.x / 7.3.x / 7.4.x / 23.1.x/ 23.2.x / 23.3.x / 23.4.x / 25.1.x / 25.2.x | Alfresco 7.0.x / 7.1.x / 7.2.x / 7.3.x / 7.4.x / 23.1.x/ 23.2.x / 23.3.x / 23.4.x / 25.1.x / 25.2.x | https://github.com/Alfresco/alfresco-sdk/tree/master/docs/README.md                                                                                                                                                                                                                  |

| SDK 4.11.0  |     Alfresco 7.0.x / 7.1.x / 7.2.x / 7.3.x / 7.4.x / 23.1.x/ 23.2.x / 23.3.x / 23.4.x / 25.1.x      |         Alfresco 7.0.x / 7.1.x / 7.2.x / 7.3.x / 7.4.x / 23.2.x / 23.3.x / 23.4.x / 25.1.x          | https://github.com/Alfresco/alfresco-sdk/tree/master/docs/README.md                                                                                                                                             |

| SDK 4.10    |          Alfresco 7.0.x / 7.1.x / 7.2.x / 7.3.x / 7.4.x / 23.1.x/ 23.2.x / 23.3.x / 23.4.x          |              Alfresco 7.0.x / 7.1.x / 7.2.x / 7.3.x / 7.4.x / 23.2.x / 23.3.x / 23.4.x              | https://github.com/Alfresco/alfresco-sdk/tree/master/docs/README.md                                                                                                                                             |

| SDK 4.9     |              Alfresco 7.0.x / 7.1.x / 7.2.x / 7.3.x / 7.4.x / 23.1.x/ 23.2.x / 23.3.x               |                  Alfresco 7.0.x / 7.1.x / 7.2.x / 7.3.x / 7.4.x / 23.2.x / 23.3.x                   | https://github.com/Alfresco/alfresco-sdk/tree/master/docs/README.md                                                                                                                                             |
@@ -166,7 +168,7 @@ To test new unreleased (unsupported) features, you can use the following snippet 
See the [Developers Wiki page](https://github.com/Alfresco/alfresco-sdk/wiki/Developer-Wiki).



## Publishing the release on Maven Central

- Manually change the version from SNAPSHOT to final (eg. when releasing SDK 4.11.0, replacing all the occurrences of 4.11.0-SNAPSHOT with 4.11.0)

- Manually change the version from SNAPSHOT to final (eg. when releasing SDK 4.12.0, replacing all the occurrences of 4.12.0-SNAPSHOT with 4.12.0)



- Commit and push changes to GitHub with the commit message [publish], then it will automatically publish your artifacts to maven central
@@ -174,6 +176,6 @@ At this point, we need to manually proceed with the remaining steps: 


1- Manually create a release tag on GitHub



2- Manually change the version from final to next SNAPSHOT (eg. replacing all the occurrences of 4.11.0 with 4.12.0-SNAPSHOT (in pom.xml, not in READMEs - if not needed)

2- Manually change the version from final to next SNAPSHOT (eg. replacing all the occurrences of 4.12.0 with 4.13.0-SNAPSHOT (in pom.xml, not in READMEs - if not needed)



3- Commit and push on GitHub

docs/getting-started.md

+3 −2
Original line number Diff line number Diff line
@@ -118,7 +118,7 @@ Choose archetype: 
* `org.alfresco.maven.archetype:alfresco-platform-jar-archetype`

* `org.alfresco.maven.archetype:alfresco-share-jar-archetype`



3. Choose the latest version, such as 4.11.0.

3. Choose the latest version, such as 4.12.0.



```

Choose org.alfresco.maven.archetype:alfresco-allinone-archetype version:
@@ -146,6 +146,7 @@ Choose org.alfresco.maven.archetype:alfresco-allinone-archetype version: 
22: 4.9.0

23: 4.10.0

24: 4.11.0

25: 4.12.0

```



4. Next you will be prompted for additional values, like groupId, artifactId, and package, as shown below:
@@ -174,7 +175,7 @@ If everything has been configured correctly, you should see something similar to 


```

[INFO] ----------------------------------------------------------------------------

[INFO] Using following parameters for creating project from Archetype: alfresco-allinone-archetype:4.11.0

[INFO] Using following parameters for creating project from Archetype: alfresco-allinone-archetype:4.12.0

[INFO] ----------------------------------------------------------------------------

[INFO] Parameter: groupId, Value: com.acme

[INFO] Parameter: artifactId, Value: my-all-in-one

docs/whats-new.md

+3 −3
Original line number Diff line number Diff line
@@ -10,7 +10,7 @@ Alfresco Share 6. 


This was a mayor release oriented to support Alfresco 6, so it is not compatible with previous versions of the SDK.



Alfresco SDK 4.11.0 extends the support to Alfresco 25.1. 

Alfresco SDK 4.12.0 extends the support to Alfresco 25.2. 

Use an older SDK version for Alfresco 6. 



## Embracing containers and Docker
@@ -64,9 +64,9 @@ environment can be more similar to a real one, including whatever other service 


Alfresco SDK 4.1 provides support for Alfresco 6.2.x.



## Support for Alfresco 7.0.x, 7.1.x, 7.2.x, 7.3.x, 7.4.x. 23.1.x, 23.2.x, 23.3.x, 23.4.x and 25.1.x

## Support for Alfresco 7.0.x, 7.1.x, 7.2.x, 7.3.x, 7.4.x. 23.1.x, 23.2.x, 23.3.x, 23.4.x, 25.1.x and 25.2.x



Alfresco SDK 4.11.0 provides support for Alfresco 7.0.x, 7.1.x, 7.2.x, 7.3.x, 7.4.x, 23.1.x, 23.2.x, 23.3.x, 23.4.x and 25.1.x

Alfresco SDK 4.12.0 provides support for Alfresco 7.0.x, 7.1.x, 7.2.x, 7.3.x, 7.4.x, 23.1.x, 23.2.x, 23.3.x, 23.4.x, 25.1.x and 25.2.x.



## Support for Java 17

[Java 17](https://openjdk.java.net/projects/jdk/17/) is the latest stable long term (8 year support) version after Java 11. Alfresco 7.3.x already offers