Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "Californium/Release Process"

(Added description for Hudson based release build)
m (Skip local tagging during git clone in Hudson)
Line 3: Line 3:
  
 
Californium consists of the following components
 
Californium consists of the following components
−
* Element Connector
+
# Californium (parent)
−
* Californium (parent)
+
# Element Connector
−
* Californium (core)
+
# Californium (core)
−
* Scandium
+
# Scandium
−
* Tools
+
# Tools
−
* Actinium
+
# 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 ===
 
=== Repositories ===
  
−
The source code for these components is managed in separate GitHub repositories as follows:
+
The source code for Californium's components is managed in separate GitHub repositories as follows:
 
{| class="wikitable"
 
{| class="wikitable"
 +
|Californium (parent)
 +
|https://github.com/eclipse/californium.git
 +
|-
 
|Element Connector
 
|Element Connector
 
|https://github.com/eclipse/californium.element-connector.git
 
|https://github.com/eclipse/californium.element-connector.git
−
|-
 
−
|Californium (parent)
 
−
|https://github.com/eclipse/californium.git
 
 
|-
 
|-
 
|Californium (core)
 
|Californium (core)
Line 33: Line 35:
 
|-
 
|-
 
|}
 
|}
−
 
−
In order to create a release from the command line, all these repositories need to be checked out first:
 
−
 
−
<code>
 
−
git clone git@github.com:eclipse/californium.element-connector.git
 
−
 
−
git clone git@github.com:eclipse/californium.scandium.git
 
−
 
−
git clone git@github.com:eclipse/californium.git
 
−
 
−
git clone git@github.com:eclipse/californium.core.git
 
−
 
−
git clone git@github.com:eclipse/californium.tools.git
 
−
 
−
git clone git@github.com:eclipse/californium.actinium.git
 
−
</code>
 
−
 
−
Some of the components have dependencies on other components. Thus, the repositories need to be built in the following order:
 
−
 
−
# Californium (parent)
 
−
# Element Connector
 
−
# Californium (core)
 
−
# Scandium
 
−
# Tools
 
−
# Actinium
 
  
 
=== Release Process ===
 
=== Release Process ===
  
−
The following table contains instructions for building and releasing a single repository both from the command line as well as from a Hudson build job.
+
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.
  
 
{| class="wikitable"
 
{| class="wikitable"
 
!Step
 
!Step
 
!Command Line
 
!Command Line
−
!Hudson
+
!Hudson Build Job Configuration
 
|-
 
|-
 
|Create build job
 
|Create build job
−
| nothing to do
+
| not necessary
 
|
 
|
 
# Create a new build job using the '''Build a free-style software job''' option
 
# Create a new build job using the '''Build a free-style software job''' option
 
# Check the '''This build is parameterized''' checkbox and add the following parameters:
 
# Check the '''This build is parameterized''' checkbox and add the following parameters:
−
## '''RELEASE_VERSION''' - no '''Default Value''' necessary
+
## '''RELEASE_VERSION''' - no '''Default Value'''
−
## '''NEXT_VERSION''' - no '''Default Value''' necessary
+
## '''NEXT_VERSION''' - no '''Default Value'''
 
# Under '''Advanced Job Options''' click the '''Advanced...''' button
 
# Under '''Advanced Job Options''' click the '''Advanced...''' button
 
# Check the '''Clean workspace before build''' checkbox
 
# Check the '''Clean workspace before build''' checkbox
 
|-
 
|-
 
|Checkout repository
 
|Checkout repository
−
|<code>git clone git@github.com:eclipse/californium.git</code>
+
|<code>git clone https://github.com/eclipse/californium.git</code>
 
|Fill out '''Source Code Management''' section of build configuration like this:
 
|Fill out '''Source Code Management''' section of build configuration like this:
 
# '''Url of repository''': ''ssh://deploy_github_eclipse_californium/eclipse/californium.git''
 
# '''Url of repository''': ''ssh://deploy_github_eclipse_californium/eclipse/californium.git''
Line 85: Line 63:
 
# click '''Advanced...''' button in the '''Branches to build''' section to expand more options
 
# click '''Advanced...''' button in the '''Branches to build''' section to expand more options
 
# '''Checkout/merge to local branch''': ''master''
 
# '''Checkout/merge to local branch''': ''master''
 +
# check '''Skip internal tag'''
 
# check '''Use Command line git to clone'''
 
# check '''Use Command line git to clone'''
 
|-
 
|-

Revision as of 04:22, 28 October 2015

How-to release Californium

Californium consists of the following components

  1. Californium (parent)
  2. Element Connector
  3. Californium (core)
  4. Scandium
  5. Tools
  6. 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:

Californium (parent) https://github.com/eclipse/californium.git
Element Connector https://github.com/eclipse/californium.element-connector.git
Californium (core) https://github.com/eclipse/californium.core.git
Scandium https://github.com/eclipse/californium.scandium.git
Tools https://github.com/eclipse/californium.tools.git
Actinium https://github.com/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.

Step Command Line Hudson Build Job Configuration
Create build job not necessary
  1. Create a new build job using the Build a free-style software job option
  2. Check the This build is parameterized checkbox and add the following parameters:
    1. RELEASE_VERSION - no Default Value
    2. NEXT_VERSION - no Default Value
  3. Under Advanced Job Options click the Advanced... button
  4. Check the Clean workspace before build checkbox
Checkout repository git clone https://github.com/eclipse/californium.git Fill out Source Code Management section of build configuration like this:
  1. Url of repository: ssh://deploy_github_eclipse_californium/eclipse/californium.git
  2. Branch specifier: master
  3. click Advanced... button in the Branches to build section to expand more options
  4. Checkout/merge to local branch: master
  5. check Skip internal tag
  6. check Use Command line git to clone
Set release version (probably the same as the current one but without the -SNAPSHOT suffix)

mvn versions:set -DnewVersion=X.Y.Z

  1. In the Build section click the Add build step drop-down list and select Invoke Maven 3
  2. In the newly created build step set
    1. Goals: versions:set
    2. Properties: newVersion=${RELEASE_VERSION}
Build & test the code

mvn clean install

  1. Click the Add build step drop-down list and select Invoke Maven 3
  2. In the newly created build step set
    1. Goals: clean install
    2. Properties: maven.test.failure.ignore=false snapshotDependencyAllowed=false
Commit pom.xml containing the release version and create a corresponding tag for it

git add pom.xml \*/pom.xml

git commit -m "Release X.Y.Z"

git tag "X.Y.Z"

  1. Click the Add build step drop-down list and select Execute shell
  2. In the newly created build step add the following script

git add pom.xml \*/pom.xml

git commit -m "Release ${RELEASE_VERSION}"

git tag ${RELEASE_VERSION}

Publish artifacts to Eclipse release repository

mvn deploy -DskipStaging=true -DenableEclipseJarSigner=true

  1. Click the Add build step drop-down list and select Invoke Maven 3
  2. In the newly created build step set
    1. Goals: mvn:deploy
    2. Properties: skipStaging=true enableEclipseJarSigner=true
Publish artifacts to Maven Central's staging repo

mvn deploy

  1. Click the Add build step drop-down list and select Invoke Maven 3
  2. In the newly created build step set
    1. Goals: mvn:deploy
    2. Properties: createGPGSignature=true
Set next development version

mvn versions:set -DnewVersion=X.Y.Z-SNAPSHOT

  1. Click the Add build step drop-down list and select Invoke Maven 3
  2. In the newly created build step set
    1. Goals: versions:set
    2. Properties: newVersion=${NEXT_VERSION}
Push changes to SCM

git add pom.xml \*/pom.xml

git commit -m "Release X.Y.Z"

git push && git push --tags

  1. Click the Add build step drop-down list and select Execute shell
  2. In the newly created build step add the following script

git add pom.xml \*/pom.xml

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.element-connector.git

git clone git@github.com:eclipse/californium.scandium.git

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:

element-connector

scandium

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>
Retrieved from "https://wiki.eclipse.org/index.php?title=Californium/Release_Process&oldid=393166"

Back to the top