These instructions coemplement those from http://sling.apache.org/documentation/development/release-management.html, which are geared more towards bundle releases, while releasing the Launchpad is a bit more involved.
Prepare the Starter release
Since the Launchpad is a collection of bundles, it is required for each bundle included it in to be a release, rather than a SNAPSHOT. We currently have only releases in the starter, so this should not be an issue.
Create a new and noteworthy page
A new and notheworthy page outlines some of the significant changes done since the last release. The launchpad-comparator Java project allows generating a changelog between two versions of the Sling Starter and can be used to extract the new and noteworthy items. The README file from that project contains all the information needed to generate the changelog.
Additionally, we tag issues that we consider noteworthy with the label
Sling-VERSION-ReleaseNotes. For instance, the query for the Sling 11 release notes is project = SLING AND labels = Sling-11-ReleaseNotes ORDER BY updated DESC .
- https://sling.apache.org/news/sling-launchpad-8-released.html .
Update and release the "core" set of artifacts
Although the Sling Starter is composed of just one artifact, we aim to release at least the tests and the Maven archetypes at the same time. We release the tests to capture the state of how Sling worked for that certain release, and the archetypes to allow users to start using them with the latest Starter version from day one.
Currently we release the following artifacts (TBD):
- Sling Starter
- Sling Launchpad Testing
- Sling Launchpad Testing WAR
- Sling Launchpad Integration Tests
- Sling Launchpad Test Services
- Sling Launchpad Test Services WAR
- Sling Launchpad Test Fragment
- Sling Launchpad Test Bundles
- Archetype Parent
- Bundle Archetype
- JCRInstall Bundle Archetype
- Initial Content Archetype
- Slingstart Archetype
The diagram below shows the projects that were released for Sling 11 and their dependencies. Some unrelated dependencies (blue) were also released as they were used as snapshots. Only one archetype (magenta) was released as the others did not need any changes.
Deploy the new API docs
For each version we deploy the aggregated javadoc for for the Sling bundles contained in the launchpad. The javadoc can be generated using the generate_javadoc_for_release.sh script. The script picks up artifacts from the Starter file, and manually adds others which we consider required, such as annotations. Any additional artifacts should be manually added to the script.
Deploy the docker image on DockerHub
Since Sling 8 release we also provide a docker image. The Dockerfile can be found in the sling-org-apache-sling-starter-docker repo. For instructions on deploying to DockerHub, see the
/repos/private/pmc/sling SVN repository.
Note that, like for any Apache artifacts, the
sling-org-apache-sling-starter-docker module must be released before deploying binaries (like the Docker image) to public places.
Bertrand Delacretaz says: I like the way https://hub.docker.com/r/apache/couchdb/ just describes their Docker image as "Unofficial convenience binaries for CouchDB, the RESTful document-oriented database" and redirects people to their GitHub repository at https://github.com/apache/couchdb-docker for more info. It makes it clear what the role of that image is and might help bring people closer to the community. We might want to do the same eventually, next time we make changes to the image description.
Update local references to the old starter
A number of projects in the sling source tree typically reference the Sling starter mostly for testing. These projects should be updated to either reference the latest release, if they use it for testing additional sets of bundles, or to the latest SNAPSHOT, if they are used to test the current launchpad, like launchpad/testing or launchpad/testing-war .
Change version of dependant projects
The following projects should keep their versions in sync with the main launchpad:
For future releases we should consider releasing the launchpad/testing and launchpad/testing-war projects ( and dependant test projects ) alongside the main launchpad project, so that the test state is recorded as well.
Clean up starter documentation
There may be references to old features of the starter at https://sling.apache.org/documentation/the-sling-engine/the-sling-launchpad.html, so make sure that this is up to date.
- Launchpad 8 release tracking task: - SLING-5095Getting issue details... STATUS
- email@example.com: Sling 8 release checklist
- firstname.lastname@example.org: Launchpad 7 release?
- Towards Sling 6
- email@example.com: Sling 6 release plan