incubator-celix-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From abroekh...@apache.org
Subject svn commit: r1549790 - /incubator/celix/site/trunk/content/celix/documentation/releasing.mdtext
Date Tue, 10 Dec 2013 09:07:49 GMT
Author: abroekhuis
Date: Tue Dec 10 09:07:49 2013
New Revision: 1549790

URL: http://svn.apache.org/r1549790
Log:
CELIX-100: Updated links and formatting.

Modified:
    incubator/celix/site/trunk/content/celix/documentation/releasing.mdtext

Modified: incubator/celix/site/trunk/content/celix/documentation/releasing.mdtext
URL: http://svn.apache.org/viewvc/incubator/celix/site/trunk/content/celix/documentation/releasing.mdtext?rev=1549790&r1=1549789&r2=1549790&view=diff
==============================================================================
--- incubator/celix/site/trunk/content/celix/documentation/releasing.mdtext (original)
+++ incubator/celix/site/trunk/content/celix/documentation/releasing.mdtext Tue Dec 10 09:07:49
2013
@@ -60,10 +60,10 @@ Besides this information, the version ne
 is defined in the top-level CMakeLists.txt file.
 Update the following pieces:
 
-  - SET(CELIX_MAJOR "X")
-  - SET(CELIX_MINOR "Y")
-  - SET(CELIX_MICRO "Z")
-  - SET(CELIX_QUALIFIER "incubating")
+    SET(CELIX_MAJOR "X")
+    SET(CELIX_MINOR "Y")
+    SET(CELIX_MICRO "Z")
+    SET(CELIX_QUALIFIER "incubating")
 
 While Celix is in incubation, the qualifier should (at least) always contain "incubating"
as text.
 
@@ -73,10 +73,35 @@ Note: The DEFAULT_VERSION property is us
 Before creating a branch, be sure that the source compiles and tests run successfully. If
there are any known shortcomings, make sure they are listed in the 
 RELEASE_NOTES. Details for compiling and testing are available in the BUILDING file.
 
+    // Create a directory as sibling of the celix release directory
+    > mkdir celix-build
+    > cd celix-build
+    // Run CMake to generate the makefiles. Enable all BUILD options.
+    > ccmake ../celix
+    > make
+    > make deploy
+    > make test
+
 Also verify that the provides examples work as expected. If needed ask other committers to
test parts, eg the GTK examples.
 
+    // Go to the deploy directory to see all examples
+    > cd deploy
+    // Test the different examples, eg
+    > cd hello_world
+    > sh run.sh
+    // Depending on the example the output might be different. Most examples provide a shell
to inspect the framework.
+    // To list the commands use the "help" command.
+    -> help
+    ....
+
 After verifying the build, run Apache RAT to check for any licensing problems. If Apache
RAT is configured in the CMake build the "rat" target can be used to run
-the check: make rat 
+the check.
+
+    // From the celix-build directory
+    // Run CMake to set the APACHE_RAT library (path to the JAR file).
+    > ccmake ../celix
+    // Run RAT
+    > make rat
 
 Apache RAT should not raise any concers, if there are, check the source files for 
 a license header. If it is a false positive update the rat-excludes.txt file in the root
of the project. Be sure it is a false positive! If in doubt, ask the 
@@ -89,7 +114,9 @@ The tag should be named like this: celix
 
 To make a tag use the following command:
 
-svn copy http://svn.apache.org/repos/asf/incubator/celix/trunk/ http://svn.apache.org/repos/asf/incubator/celix/tags/celix-X.Y.Z.incubating
-m "X.Y.Z release of the Apache Celix project."
+    svn copy http://svn.apache.org/repos/asf/incubator/celix/trunk/ \
+        http://svn.apache.org/repos/asf/incubator/celix/tags/celix-X.Y.Z.incubating \
+        -m "X.Y.Z release of the Apache Celix project."
 
 Note: Make sure there are no new changes made on trunk while working on the release. Discuss:
Use a branch for staging the release and the files? Or possibly use a revision nr?
 
@@ -123,32 +150,32 @@ Since Apache Celix is still in incubatio
 The first vote has to be done on the public mailinglist of the project itself (celix-dev@incubator.apache.org).
The following template must be used for this vote:
 
 ================================================================================================================
-To: celix-dev@incubator.apache.org
-Subject: [VOTE] Release Celix version X.Y.Z
+    
+    To: celix-dev@incubator.apache.org
+    Subject: [VOTE] Release Celix version X.Y.Z
 
-This is the release vote for Apache Celix, version X.Y.Z.
+    This is the release vote for Apache Celix, version X.Y.Z.
 
-It fixes the following issues: 
-{Create Release Note link using [Apache Celix Jira](https://issues.apache.org/jira/secure/ReleaseNote.jspa?version=12323511)}
+    It fixes the following issues: 
+    {Create Release Note link using https://issues.apache.org/jira/secure/ReleaseNote.jspa?version=12323511}
 
-Source files:
-https://dist.apache.org/repos/dist/dev/incubator/celix/celix-X.Y.Z-incubating/
+    Source files:
+    https://dist.apache.org/repos/dist/dev/incubator/celix/celix-X.Y.Z-incubating/
 
-The tag to be voted upon:
-http://svn.apache.org/repos/asf/incubator/celix/tags/celix-X.Y.Z-incubating/
+    The tag to be voted upon:
+    http://svn.apache.org/repos/asf/incubator/celix/tags/celix-X.Y.Z-incubating/
 
-Celix's keys can be found at:
-https://dist.apache.org/repos/dist/dev/incubator/celix/KEYS
+    Celix's keys can be found at:
+    https://dist.apache.org/repos/dist/dev/incubator/celix/KEYS
 
-Information for voting on a release can be found at http://www.apache.org/dev/release.html#approving-a-release
+    Information for voting on a release can be found at http://www.apache.org/dev/release.html#approving-a-release
 
-Please vote to approve this release:
+    Please vote to approve this release:
 
-[ ] +1 Approve the release
+    [ ] +1 Approve the release
+    [ ] -1 Disapprove the release (please provide specific comments)
 
-[ ] -1 Disapprove the release (please provide specific comments)
-
-This vote will be open for at least 72 hours.
+    This vote will be open for at least 72 hours.
 
 ================================================================================================================
 
@@ -160,13 +187,14 @@ has had enough time to review the releas
 The template provided above can be reused for this, but needs to be extended (directly after
"This is the release vote for..." with the following information:
 
 ================================================================================================================
-This release has already been approved by:
+    
+    This release has already been approved by:
 
-  - Name of Approver (apache ID) (binding|not binding)
-  - Name of Approver (apache ID) (binding|not binding)
-  - ...
+    - Name of Approver 1 (apache ID) (binding|not binding)
+    - Name of Approver 2 (apache ID) (binding|not binding)
+    - ...
 
-See {Create link to the archive of Celix release thread using [Markmail](http://incubator.markmail.org/search/?q=list%3Aorg.apache.incubator.celix-dev)}
for their votes.
+    See {Create link to the archive of Celix release thread using http://incubator.markmail.org/search/?q=list%3Aorg.apache.incubator.celix-dev}
for their votes.
 
 ================================================================================================================
 
@@ -183,11 +211,47 @@ of vote threads. See [Voting Status](htt
 If the vote is passed successfully the release can be moved from the "dev" area to "release".
The automated svnpubsub will move the artifact to the correct 
 server for mirroring. Mirroring typically can take up to 24 hours.
 
+Besides uploading the new release, the old release should be archived. Since archiving is
already automated, it is only needed to delete the previous version from the release
+area. See the [Apache Release Guide](http://www.apache.org/dev/release.html#when-to-archive)
for more information.
+
 See the [Apache Release Guide](http://www.apache.org/dev/release.html#upload-ci) for more
information.
 
-After these 24 hours the release can be announced. 
+After these 24 hours the release can be announced.
 
 ## Announce the release
-Update website's "news section".
+Update website's [News](http://incubator.apache.org/celix/index.html) and [Download](http://incubator.apache.org/celix/download.html)
sections to include the new release.
+
+On the "Download" page, the old release can be replaced with the new one, there is no need
to keep a link to archived versions. The "News" section can simply be extended
+with an additional entry.
+
+Additionally it is a good idea to post a message to "announce@apache.org" and "celix-dev@incubator.apache.org".
(note: the from address must be a ...@apache.org address).
+
+The following template must be used:
+
+================================================================================================================
+
+    To: announce@apache.org, celix-dev@incubator.apache.org
+    Subject: [ANNOUNCE] Apache Celix X.Y.Z.incubating released
+
+    The Apache Celix team is pleased to announce the release of Celix X.Y.Z.incubating.
+
+    Celix is an implementation of the OSGi specification adapted to C. It will follow the
API 
+    as close as possible, but since the OSGi specification is written primarily for Java,
there 
+    will be differences. An important aspect of the implementation is interoperability between

+    Java and C. This interoperability is achieved by porting and implementing the Remote

+    Services specification in Celix.
+
+    This new release focusses on .... {add additional information for this release}
+
+    The release is available here:
+    http://incubator.apache.org/celix/download.cgi
+
+    The full change log is available here:
+    {Create Release Note link using https://issues.apache.org/jira/secure/ReleaseNote.jspa?version=12323511}
+
+    We welcome your help and feedback. For more information on how to report problems, 
+    and to get involved, visit the project website at http://incubator.apache.org/celix/
+
+    The Apache Celix Team
 
-Post message to "announce@apache.org"?
\ No newline at end of file
+================================================================================================================
\ No newline at end of file



Mime
View raw message