Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Californium/Release Process
Contents
How-to release Californium
Californium consists of the following components
- Californium (parent)
- Element Connector
- Scandium
- Californium core
- Tools
- Actinium
Some of the components have dependencies on other components. Thus, in order to successfully build all of the components they need to be built in the order given above.
Repositories
The source code for Californium's components is managed in separate GitHub repositories as follows:
Component | Standard URI | SSH URI (to be used on HIPP) |
---|---|---|
Californium (Core + Scandium + element-connector) | https://github.com/eclipse/californium.git | ssh://deploy_github_eclipse_californium/eclipse/californium.git |
Tools | https://github.com/eclipse/californium.tools.git | ssh://deploy_github_eclipse_californium.tools/eclipse/californium.tools.git |
Actinium | https://github.com/eclipse/californium.actinium.git | ssh://deploy_github_eclipse_californium.actinium/eclipse/californium.actinium.git |
Release Process
The repositories mentioned above can be built either from the command line or using a separate Hudson build job for each repository. The following table contains the steps required to build and release a repository and the corresponding actions from the command line or the respective Hudson build job configuration required to make it happen.
The Standard URIs from the table above are supposed to be used from the command line whereas the SSH URIs need to be used in build jobs on our HIPP instance in order to be able to push tags created during the build back to GitHub using deploy keys associated with the SSH URIs.
Step | Command Line | Hudson Build Job Configuration |
---|---|---|
Create build job | not necessary |
|
Checkout repository | Use the Standard URI from the table above to clone the repositorygit clone https://github.com/eclipse/californium.git
|
Fill out Source Code Management section of build configuration like this (make sure to use the SSH URI from the table above):
|
Set release version (probably the same as the current one but without the -SNAPSHOT suffix) |
For Californium (parent): For all other components (because the artifact version is implicitly set by the parent pom): |
|
Build & test the code |
|
|
Commit pom.xml containing the release version and create a corresponding tag for it |
git commit -m "Release X.Y.Z" git tag "X.Y.Z" |
git commit -m "Release ${RELEASE_VERSION}" git tag ${RELEASE_VERSION} |
Publish artifacts to Eclipse release repository |
|
|
Publish artifacts to Maven Central's staging repo |
|
|
Set next development version |
For building Californium (parent):
For building all other components:
|
|
Push changes to SCM |
git commit -m "Release X.Y.Z" git push && git push --tags |
git commit -m "Release ${RELEASE_VERSION}" git push ssh://deploy_github_eclipse_californium/eclipse/californium.git && git push --tags ssh://deploy_github_eclipse_californium/eclipse/californium.git |
Reference Instructions
1st get a copy of all the californium repository:
git clone git@github.com:eclipse/californium.git
git clone git@github.com:eclipse/californium.tools.git
git clone git@github.com:eclipse/californium.actinium.git
You need to process the repository in the correct order:
californium
tools
actinium
In each repository:
- set the final version (probably the same as the current one but without "SNAPSHOT")
mvn versions:set -DnewVersion=X.Y.Z
- build & sign the artifacts (you need a gpg key; see below)
mvn clean install -Prelease
- looks in ./target/ does the artifacts looks nice?
- check if there is no *-SNAPSHOT in the dependency:
mvn dependency:tree
- then commit the pom.xml, and tag the release:
git add pom.xml \*/pom.xml
git commit -m "Release X.Y.Z"
git tag "X.Y.Z"
- publish the artifacts on maven central
mvn deploy -Prelease
- prepare for the next cycle:
mvn versions:set -DnewVersion=X.Y.Z-SNAPSHOT
git add pom.xml \*/pom.xml
git commit -m "Release X.Y.Z"
- push the commits
git push && git push --tags
Now connect on the Sonatype OSS Nexus and close the staging repository. If it's fine you will be able to "release" the repository and the artifact will show up in maven central in a few hours. Next step is to edit the Eclipse project metadata and announce it on the mailing list.
GPG Help
Under CygWin the following error might occur:
gpg: cannot open tty `no tty': No such file or directory
This can be fixed by configuring gpg through an active profile in .m2\settings.xml
where also the Sonatype password is stored:
<settings> <servers> <server> <id>ossrh</id> <username>[username]</username> <password>[password]</password> </server> </servers> <profiles> <profile> <id>gpg</id> <properties> <gpg.executable>gpg</gpg.executable> <gpg.passphrase>[password]</gpg.passphrase> </properties> </profile> </profiles> <activeProfiles> <activeProfile>gpg</activeProfile> </activeProfiles> </settings>