Repository: commons-text Updated Branches: refs/heads/master 931caaa3d -> 44dd95479
Adding to changes.xml and adding RELEASE-NOTES.txt Project: http://git-wip-us.apache.org/repos/asf/commons-text/repo Commit: http://git-wip-us.apache.org/repos/asf/commons-text/commit/44dd9547 Tree: http://git-wip-us.apache.org/repos/asf/commons-text/tree/44dd9547 Diff: http://git-wip-us.apache.org/repos/asf/commons-text/diff/44dd9547 Branch: refs/heads/master Commit: 44dd95479e527128a0fdec31a089c2e67deb98f2 Parents: 931caaa Author: Rob Tompkins <chtom...@gmail.com> Authored: Wed Jan 25 09:47:11 2017 -0500 Committer: Rob Tompkins <chtom...@gmail.com> Committed: Wed Jan 25 09:47:11 2017 -0500 ---------------------------------------------------------------------- RELEASE-NOTES.txt | 96 +++++++++++++++++++++++++++ pom.xml | 4 +- src/changes/changes.xml | 26 +++++++- src/changes/release-notes.vm | 134 ++++++++++++++++++++++++++++++++++++++ 4 files changed, 257 insertions(+), 3 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/commons-text/blob/44dd9547/RELEASE-NOTES.txt ---------------------------------------------------------------------- diff --git a/RELEASE-NOTES.txt b/RELEASE-NOTES.txt new file mode 100644 index 0000000..73c3a17 --- /dev/null +++ b/RELEASE-NOTES.txt @@ -0,0 +1,96 @@ + Apache Commons Text + Version 1.0-beta-1 + Release Notes + + +INTRODUCTION +============ + +This document contains the release notes for the 1.0-beta-1 version of Apache +Commons Text. Commons Text is a set of utility functions and reusable components +for the purpose of processing and manipulating text that should be of use in a +Java environment. + +Apache Commons Text is a library focused on algorithms working on strings. + +JAVA 9 SUPPORT +============== + +At our time of release our build succeeds with Java 9-ea build 153, and we +believe all of our features to be Java 9 compatible. + +NEW FEATURES +============ + +o TEXT-56: Move CvsTranslators out of StringEscapeUtils and make them DRY + Thanks to Jarek Strzeleck. +o TEXT-40: Escape HTML characters only once Thanks to Sampanna Kahu. +o TEXT-32: Add LCS similarity and distance +o TEXT-34: Add class to generate random strings +o TEXT-29: Add a builder to StringEscapeUtils +o TEXT-28: Add shell/XSI escape/unescape support +o TEXT-2: Add Jaccard Index and Jaccard Distance Thanks to Don Jeba. +o TEXT-27: Move org.apache.commons.lang3.StringEscapeUtils.java into text +o TEXT-23: Moving from commons-lang, the package org.apache.commons.lang3.text +o TEXT-10: A more complex Levenshtein distance Thanks to Don Jeba. +o TEXT-24: Add coveralls and Travis.ci integration +o TEXT-19: Add alphabet converter Thanks to Eyal Allweil. +o TEXT-13: Create Commons Text logo +o TEXT-7: Write user guide +o TEXT-15: Human name parser +o TEXT-3: Add Cosine Similarity and Cosine Distance +o TEXT-4: Port Myers algorithm from [collections] +o TEXT-1: Add Hamming distance +o TEXT-9: Incorporate String algorithms from Commons Lang Thanks to britter. + +FIXED BUGS +========== + +o TEXT-60: Upgrading Jacoco for Java 9-ea compatibility. Thanks to Lee Adcock. +o TEXT-52: Possible attacks through StringEscapeUtils.escapeEcmaScrip better + javadoc +o TEXT-37: Global vs local source of randomness +o TEXT-38: Fluent API in "RandomStringBuilder" +o TEXT-26: Fix JaroWinklerDistance in the manner of LUCENE-1297 +o TEXT-35: Unfinished class Javadoc for CosineDistance +o TEXT-22: LevenshteinDistance reduce memory consumption +o TEXT-5: IP clearance for the names package +o TEXT-11: Work on the string metric, distance, and similarity definitions for + the project +o TEXT-12: Create StringDistanceFrom class that contains a StringMetric and + the "left" side string. This would have a method that accepts the + "right" side string to test. Thanks to Jonathan baker. +o TEXT-8: Change (R) StringMetric.compare(CS left, CS right) to "apply" so + that it is consistent with BiFunction. Thanks to Jonathan Baker. +o TEXT-6: Allow extra information (e.g. Levenshtein threshold) to be stored + as (final) fields in the StringMetric instance. Thanks to Jonathan + Baker. + +CHANGES +======= + +o TEXT-61: Naming packages org.apache.commons.text.beta Thanks to Lee Adcock. +o TEXT-58: Refactor EntityArrays to have unmodifiableMaps in leu of String[][] +o TEXT-53: Prepare site for 1.0 release +o TEXT-50: Upgrade from commons-parent version 41 to version 42 +o TEXT-33: Consolidating since tags at 1.0, removing deprecated methods +o TEXT-16: Improve HumanNameParser + +REMOVED +======= + +o TEXT-55: Remove WordUtils to be added back in an upcoming 1.X release +o TEXT-51: Remove RandomStringGenerator to be added back in the 1.1 release +o TEXT-31: Remove org.apache.commons.text.names, for later release than 1.0 + + +Historical list of changes: http://commons.apache.org/text/changes-report.html + +For complete information on Apache Commons Text, including instructions on how +to submit bug reports, patches, or suggestions for improvement, see the Apache +Apache Commons Text website: + +http://commons.apache.org/text/ + +Have fun! +-Apachje Commons Text team \ No newline at end of file http://git-wip-us.apache.org/repos/asf/commons-text/blob/44dd9547/pom.xml ---------------------------------------------------------------------- diff --git a/pom.xml b/pom.xml index 77b0ab7..af26b9d 100644 --- a/pom.xml +++ b/pom.xml @@ -26,7 +26,7 @@ </parent> <modelVersion>4.0.0</modelVersion> <artifactId>commons-text</artifactId> - <version>1.0-beta-1</version> + <version>1.0-SNAPSHOT</version> <name>Apache Commons Text</name> <inceptionYear>2014</inceptionYear> @@ -125,7 +125,7 @@ <commons.componentid>text</commons.componentid> <!-- Current 3.x release series --> - <commons.release.version>1.0-beta-1</commons.release.version> + <commons.release.version>1.0</commons.release.version> <commons.release.desc>(Java 7+)</commons.release.desc> <commons.jira.id>TEXT</commons.jira.id> http://git-wip-us.apache.org/repos/asf/commons-text/blob/44dd9547/src/changes/changes.xml ---------------------------------------------------------------------- diff --git a/src/changes/changes.xml b/src/changes/changes.xml index 691c9a4..0f8ca6f 100644 --- a/src/changes/changes.xml +++ b/src/changes/changes.xml @@ -15,13 +15,37 @@ See the License for the specific language governing permissions and limitations under the License. --> + +<!-- +This file is also used by the maven-changes-plugin to generate the release notes. +Useful ways of finding items to add to this file are: + +1. Add items when you fix a bug or add a feature (this makes the +release process easy :-). + +2. Do a JIRA search for tickets closed since the previous release. + +3. Use the report generated by the maven-changelog-plugin to see all +git commits. TBA how to use this with git. + +To generate the release notes from this file: + +mvn changes:announcement-generate -Prelease-notes [-Dchanges.version=nnn] + +then tweak the formatting if necessary +and commit + +The <action> type attribute can be add,update,fix,remove. +--> + + <document> <properties> <title>Apache Commons Text Changes</title> </properties> <body> - <release version="1.0" date="tba" description="First release of Commons Text"> + <release version="1.0-beta-1" date="2017-01-25" description="First release (beta) of Commons Text"> <action issue="TEXT-61" type="update" dev="chtompki" due-to="Lee Adcock">Naming packages org.apache.commons.text.beta</action> <action issue="TEXT-60" type="fix" dev="chtompki" due-to="Lee Adcock">Upgrading Jacoco for Java 9-ea compatibility.</action> <action issue="TEXT-58" type="update" dev="chtompki">Refactor EntityArrays to have unmodifiableMaps in leu of String[][]</action> http://git-wip-us.apache.org/repos/asf/commons-text/blob/44dd9547/src/changes/release-notes.vm ---------------------------------------------------------------------- diff --git a/src/changes/release-notes.vm b/src/changes/release-notes.vm new file mode 100644 index 0000000..5511423 --- /dev/null +++ b/src/changes/release-notes.vm @@ -0,0 +1,134 @@ +## 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. +## + +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. + + +${project.name} +Version ${version} +Release Notes + + +INTRODUCTION: + +This document contains the release notes for the ${version} version of Apache Commons Text. +Commons Text is a set of utility functions and reusable components for the purpose of processing +and manipulating text that should be of use in a Java environment. + + +$introduction.replaceAll("(?<!\015)\012", " +").replaceAll("(?m)^ +","") + +## N.B. the available variables are described here: +## http://maven.apache.org/plugins/maven-changes-plugin/examples/using-a-custom-announcement-template.html +## +## Hack to improve layout: replace all pairs of spaces with a single new-line +$release.description.replaceAll(" ", " +") + +## set up indent sizes. Only change indent1 +#set($props=${project.properties}) +#set($jiralen=$props.get("commons.jira.id").length()) +## indent1 = POOL-nnnn: +#set($blanklen=$jiralen+6)## +6 for "-nnnn:" +## must be at least as long as the longest JIRA id +#set($blanks=" ") +#set($indent1=$blanks.substring(0,$blanklen)) +## indent2 allows for issue wrapper +#set($indent2="$indent1 ") +## +#macro ( processaction ) +## Use replaceAll to fix up LF-only line ends on Windows. + #set($action=$actionItem.getAction().replaceAll("\n"," +")) +## Fix up indentation for multi-line action descriptions + #set($action=$action.replaceAll("(?m)^ +",$indent2)) + #if ($actionItem.getIssue()) + #set($issue="$actionItem.getIssue():") + ## Pad shorter issue numbers + #if ($issue.length() < $indent1.length())#set ($issue="$issue ")#end + #if ($issue.length() < $indent1.length())#set ($issue="$issue ")#end + #if ($issue.length() < $indent1.length())#set ($issue="$issue ")#end + #else + #set($issue=$indent1) + #end + #if ($actionItem.getDueTo()) + #set($dueto=" Thanks to $actionItem.getDueTo().") + #else + #set($dueto="") + #end +o $issue ${action}$dueto + #set($action="") + #set($issue="") + #set($dueto="") +#end +## +#if ($release.getActions().size() == 0) +No changes defined in this version. +#else +Changes in this version include: + + #if ($release.getActions('add').size() !=0) + New features: + #foreach($actionItem in $release.getActions('add')) + #processaction() + #end + #end + + #if ($release.getActions('fix').size() !=0) + Fixed Bugs: + #foreach($actionItem in $release.getActions('fix')) + #processaction() + #end + #end + + #if ($release.getActions('update').size() !=0) + Changes: + #foreach($actionItem in $release.getActions('update')) + #processaction() + #end + #end + + #if ($release.getActions('remove').size() !=0) + Removed: + #foreach($actionItem in $release.getActions('remove')) + #processaction() + #end + #end +## End of main loop +#end + +Historical list of changes: ${project.url}changes-report.html + +For complete information on ${project.name}, including instructions on how to submit bug reports, +patches, or suggestions for improvement, see the Apache ${project.name} website: + +${project.url} \ No newline at end of file
