reintroduce the release notes in the doc
Project: http://git-wip-us.apache.org/repos/asf/ant-ivy/repo Commit: http://git-wip-us.apache.org/repos/asf/ant-ivy/commit/79ea1342 Tree: http://git-wip-us.apache.org/repos/asf/ant-ivy/tree/79ea1342 Diff: http://git-wip-us.apache.org/repos/asf/ant-ivy/diff/79ea1342 Branch: refs/heads/2.4.x Commit: 79ea13424ff444715e85cf9d54215e765a3537d8 Parents: a1c90aa Author: Nicolas LaleveÌe <[email protected]> Authored: Thu Nov 6 21:49:58 2014 +0100 Committer: Nicolas LaleveÌe <[email protected]> Committed: Thu Nov 6 22:48:10 2014 +0100 ---------------------------------------------------------------------- doc/dev/makerelease.html | 42 ++++++---------- doc/release-notes.html | 111 ++++++++++++++++++++++++++++++++++++++++++ doc/toc.json | 4 ++ 3 files changed, 131 insertions(+), 26 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/79ea1342/doc/dev/makerelease.html ---------------------------------------------------------------------- diff --git a/doc/dev/makerelease.html b/doc/dev/makerelease.html index 936e2e6..c3e8534 100644 --- a/doc/dev/makerelease.html +++ b/doc/dev/makerelease.html @@ -34,6 +34,7 @@ On the master, check that files which require update for the release are up to d This includes particularly: CHANGES README +doc/release-notes.html <h3>2. Check out a clean copy of the branch</h3> Run the following git command to checkout the branch, revert any change and remove untracked and ignored files: <code> @@ -47,32 +48,21 @@ You need to store the current ivy xml schema in the documentation, so that it wi ant -f build-release.xml release-xsd </code> -<h3>4. Add release note page in the documentation.</h3> -Open the file doc/index.html with your favorite browser, and click on the plus button in the upper right. Choose "Release Notes" as title, and "release-notes" as page id. - -Then edit the page (hit the first button at the upper right), and copy the content of the RELEASE_NOTES file. You can also add the announcement for the release if it's already ready. - -Move the page up in the TOC using the arrow button in the toolbar at the upper right, so that it's the first child page under the "Documentation" page. - -If you take the time to make the content of the release notes more "xooki compliant" (by removing unnecessary end of lines and adding h2 h3 and h4 tags), the page could then look like something like that: -http://ant.apache.org/ivy/history/2.0.0-alpha-1.html - -And commit your changes: +And commit your changes in the branch: <code> git add doc/ivy.xsd -git add doc/release-notes.html -git commit -m "update templates, add release notes and ivy.xsd in documentation." +git commit -m "release the ivy.xsd" </code> -<h3>5. Launch the release script</h3> +<h3>4. Launch the release script</h3> <code> ant -f build-release.xml release </code> The status should be release only for final releases, and milestone for any other intermediate release. If the release script is successful, release artifacts will be waiting for you in the build/distrib directory. -<h3>6. Verify the release</h3> +<h3>5. Verify the release</h3> Check that all zips can be opened correctly, and that running 'ant' after unzipping the source distribution works properly. You can also do a smoke test with the generated ivy.jar, to see if it is able to resolve properly a basic module (for instance you can run some tutorials provided in the src/example directory in all distributions). -<h3>7. Sign and upload the artifacts</h3> +<h3>6. Sign and upload the artifacts</h3> It's now time to sign the release artifacts and upload them to a location accessible by other Apache commiters. Here is a simple way to sign the files using gnupg: @@ -90,11 +80,11 @@ end </code> Be prepared to enter your passphrase several times if you use this script, gpg will ask for your passphrase for each file to sign. -<h3>8. Prepare the Eclipse update site</h3> +<h3>7. Prepare the Eclipse update site</h3> To be able to test the release within IvyDE, it can be deployed in the IvyDE update site. See <a href="http://ant.apache.org/ivy/ivyde/history/trunk/dev/updatesite.html";>that page</a> to know how to process. -<h3>9. Create the tag</h3> +<h3>8. Create the tag</h3> As soon as you are happy with the artifacts to be released, it is time to tag the release <code> git tag 2.0.0-beta1 @@ -106,7 +96,7 @@ All artifacts in <tt>build/distrib</tt> except the <tt>maven2</tt> folder needs The artifacts should be pushed in that svn folder: https://dist.apache.org/repos/dist/dev/ant/ivy/$VERSION -<h3>10. Call for a vote to approve the release</h3> +<h3>9. Call for a vote to approve the release</h3> Cast a vote to approve the release on the [email protected] mailing list. Here is an example: @@ -128,7 +118,7 @@ Regards, ${me}, Ivy ${version} release manager </code> -<h3>11. Publish the release</h3> +<h3>10. Publish the release</h3> If the release is approved, it's now time to make it public. The artifacts in the <i>dev</i> part needs to be moved into the <i>release</i> one: <code> @@ -137,7 +127,7 @@ $ svn mv https://dist.apache.org/repos/dist/dev/ant/ivy/$VERSION https://dist.ap In order to keep the main dist area of a reasonable size, old releases should be removed. They will disapear from the main dist but will still be available via the <a href="http://archive.apache.org/dist/ant/ivy/";>archive</a>. To do so, just use the <tt>svn rm</tt> command against the artifacts or folders to remove. -<h3>12. Update the web site</h3> +<h3>11. Update the web site</h3> It's time to update the download image used on the home page and the download page. Use site/images/ivy-dl.xcf as a basis if you have <a href="http://www.gimp.org/";>gimp</a> installed. Then you can update the home page to refer to this image, and add a news item announcing the new version. Update also the download page with the new image and update the links to the download location (using a search/replace on the html source is recommended for this). @@ -174,18 +164,18 @@ And once your happy with it, commit the changes in the source directory, and in Tip: lot's of files might need to be 'added' to svn. An handy command to <tt>add</tt> any file which is not yet under version control is the following one: <code>svn add --force sources</code> -<h3>13. Deploy the Eclipse updatesite</h3> +<h3>12. Deploy the Eclipse updatesite</h3> If the Eclipse update site has already been prepared to include that new Ivy release, it is now needed to be deployed. Then follow the deployment instruction on <a href="http://ant.apache.org/ivy/ivyde/history/trunk/dev/updatesite.html";>that page</a>. -<h3>14. Announce</h3> +<h3>13. Announce</h3> Announce the release on the [email protected], [email protected], [email protected] and [email protected] mailing lists. You can also announce the release on popular web sites, like freshmeat.net (xavier is the owner of the Ivy project on freshmeat), javalobby.org, theserverside.com, dzone.com, ... -<h3>15. Update this doc</h3> +<h3>14. Update this doc</h3> If you feel like anything is missing or misleading in this release doc, update it as soon as you encounter the problem. -<h3>16. Merge your modifications back to the trunk if necessary.</h3> +<h3>15. Merge your modifications back to the trunk if necessary.</h3> Modifications on the template files do not need to be merged, but if you had troubles during your release you may want to merge your fixes back to the trunk. -<h3>17. Prepare next release</h3> +<h3>16. Prepare next release</h3> Update the file version.properties with the version of the next release so that anyone building from the trunk will obtain jar with the correct version number. Release the version in <a href="https://issues.apache.org/jira/browse/IVY";>jira</a>, and create a new unreleased version for the next planned version.</textarea> http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/79ea1342/doc/release-notes.html ---------------------------------------------------------------------- diff --git a/doc/release-notes.html b/doc/release-notes.html new file mode 100644 index 0000000..41a4225 --- /dev/null +++ b/doc/release-notes.html @@ -0,0 +1,111 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd";> +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> +<html> +<head> + <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=ISO-8859-1"> + <script type="text/javascript">var xookiConfig = {level: 0};</script> + <script type="text/javascript" src="xooki/xooki.js"></script> +</head> +<body> + <textarea id="xooki-source"> + +<h2>Announcement</h2> + +<pre> +November 17, 2014 - The Apache Ivy project is pleased to announce its 2.4.0 release. + +Apache Ivy is a tool for managing (recording, tracking, resolving and +reporting) project dependencies, characterized by flexibility, +configurability, and tight integration with Apache Ant. + +Key features of this 2.4.0 release are +* some new Ant tasks +* improved OSGI support +* numerous bug fixes as documented in Jira and in the release notes + +You can download this 2.4.0 release at: +http://ant.apache.org/ivy/download.cgi + +Issues should be reported to: +https://issues.apache.org/jira/browse/IVY + +More information can be found on the website: +http://ant.apache.org/ivy/ +</pre> + +<h3>5. List of Changes in this Release</h3> + +For details about the following changes, check our JIRA install at +http://issues.apache.org/jira/browse/ivy + +List of changes since Ivy 2.3.0: + +- NEW: the buildobr task can now work a set of resolved artifacts: useful for managing an OSGi target platform +- NEW: fixdeps task: serializes transitively resolved dependencies into an ivy.xml file +- NEW: IvyDependencyTree task : display a dependency tree on the console +- NEW: Support Conditional Setting of a Property (IVY-1367) +- NEW: Exposing some parent metadata (organisation, module, revision, branch) as properties (IVY-1288) +- NEW: symlinkmass feature based on symlink feature of ivy:retrieve (IVY-1252) (Thanks to Gene Smith) +- NEW: Agent authentication for SSH and SFTP transports (IVY-1421) +- NEW: New OSGi resolver 'osgi-agg': a chain resolver dedicated to better handle OSGi dependencies +- NEW: Add support for "packed" artifacts: .pack.gz bundles in an OSGi P2 repository for instance + +- IMPROVEMENT: Generate POMs with /xsd/maven-4.0.0.xsd reference instead of old /maven-v4_0_0.xsd (IVY-1491) (thanks to Hervé Boutemy) +- IMPROVEMENT: Add support for packed jar within an OSGi bundle +- IMPROVEMENT: ModuleRules.getRule is O(n) leading to resolution slowness (IVY-1465) (Thanks to Zhong Wang aka Kewpie) +- IMPROVEMENT: ivy:makepom will generate an exclusion when transitive=false on a dependency (IVY-1470) +- IMPROVEMENT: New LockStrategy available based on NIO FileLocks (IVY-1424) +- IMPROVEMENT: Optional <include> ivysettings directives (IVY-1392) (thanks to Yanus Poluektovich) +- IMPROVEMENT: add support for source bundles from p2 repositories +- IMPROVEMENT: add support for source URI from OBR repositories +- IMPROVEMENT: Also copy original metadata artifact (e.g. POM) on ivy:install (IVY-1431) (Thanks to Erwin Tratar) +- IMPROVEMENT: useOrigin will do avoid copy with url resolvers configured with a 'file:/' URL +- IMPROVEMENT: add support for source artifacts in buildobr task +- IMPROVEMENT: add possibility to configure the User-Agent http header by setting a property http.agent (Thanks to Tony Likhite) + +- FIX: impossible to get artifacts when data has not been loaded. (IVY-1399) (Thanks to David Turner) +- FIX: regression introduced by IVY-1457, dependency management wasn't properly handled introducing lots of resolution failures +- FIX: The SSH resolvers fails if the un-required jsch jar is missing (IVY-1471) +- FIX: failed to resolve dynamic revisions in some cases for URL repositories (IVY-1472) +- FIX: ClassCastException in Eclipse 4.4.1 (IVY-1487) (Thanks to Carsten Pfeiffer) +- FIX: NullPointerException when accessing charset to invalid URL (IVY-1452) (Thanks to Frédéric Riviere) +- FIX: Can't resolve wildcard dependencies when remote artifact server does not set content-type header (IVY-1493) (Thanks to Andrew Bernhagen) +- FIX: In IvyDE, Ivy fails to parse ivy-settings.xml file if it contains <pgp> element (thanks to Gregory Amerson) (IVY-1441) +- FIX: ParseException when "Bundle-Description" is present in OSGi MANIFEST.MF (IVY-1438) +- FIX: NIO FileLocker released locks too early (IVY-1424) (thanks to Charles Duffy) +- FIX: Ssh Resolver doesn't work with Java 7 (IVY-1408) (thanks to Mykhailo Delegan) +- FIX: Parsing publication date in Ant tasks not thread-safe (IVY-1412) +- FIX: NullPointerException when using httpclient and server doesn't return content-type header (IVY-1400) (thanks to Frederic Riviere) +- FIX: Properly handle evicted nodes in ResolveReport +- FIX: Artifact repository locking did not correctly handle threaded use (IVY-1454) (thanks to Carsten Pfeiffer) +- FIX: Better support for "Bundle-RequiredExecutionEnvironment" from an OSGi MANIFEST.MF +- FIX: When inheriting a module descriptor, also merge the exclude rules +- FIX: Correct application of mediators (ie. override) during conflict resolution (IVY-1455) +- FIX: Fix revision number mapping across namespaces (IVY-1423) +- FIX: fix a NPE when loading a composite P2 repository with no children +- FIX: fix missing configuration when fixdeps is used with a partial resolve +- FIX: XmlModuleDescriptorWritter doesn't support fully extra infos elements (IVY-1457) + +- DOCUMENTATION: Broken link in <dependency> documentation (IVY-1405) +- DOCUMENTATION: Explicitly document that threaded use is not supported. + </textarea> +<script type="text/javascript">xooki.postProcess();</script> +</body> +</html> http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/79ea1342/doc/toc.json ---------------------------------------------------------------------- diff --git a/doc/toc.json b/doc/toc.json index ef425bb..bff771f 100644 --- a/doc/toc.json +++ b/doc/toc.json @@ -5,6 +5,10 @@ "title":"Documentation", "children": [ { + "id":"release-notes", + "title":"Release Notes" + }, + { "id":"tutorial", "title":"Tutorials", "children": [
