This is an automated email from the ASF dual-hosted git repository. pottlinger pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/creadur-tentacles.git
commit 53476f5b322be4b53741be5d05b7f5ed513f6c00 Author: P. Ottlinger <pottlin...@apache.org> AuthorDate: Thu Oct 20 22:34:33 2022 +0200 TENTACLES-16: Add changelog --- changes/changes.xml | 68 ++++++++++++++++++++++++++ changes/release-notes.vm | 122 +++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 190 insertions(+) diff --git a/changes/changes.xml b/changes/changes.xml new file mode 100644 index 0000000..4c65408 --- /dev/null +++ b/changes/changes.xml @@ -0,0 +1,68 @@ +<?xml version='1.0'?> +<!-- + 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. +--> + +<!-- +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 +SVN commits. TBA how to use this with SVN. + +To generate the release notes from this file: + +mvn changes:announcement-generate -Prelease-notes [-Dchanges.version=nn] +then tweak the formatting if necessary +and commit. +Run with changes.version-parameter in order to not generate a SNAPSHOT changelog + +The <action> type attribute can be add,update,fix,remove. + + Please list action attributes in the following order: + issue - required + type - required + the rest are optional; order not important + + having the issue number first makes it easier to read the XML outline +--> +<document xmlns="http://maven.apache.org/changes/1.0.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/changes/1.0.0 http://maven.apache.org/xsd/changes-1.0.0.xsd"> + <properties> + <title>Changes in Apache Creadur Tentacles</title> + <author email="d...@creadur.apache.org">Apache Creadur Tentacles developers</author> + </properties> + + <body> + <!--release version="0.2-SNAPSHOT" date="xxxx-yy-zz" description="Current SNAPSHOT - release to be done"> + <action issue="TENTACLES-xxx" type="update" dev="pottlinger" due-to="dependabot"> + TODO: collect all dependabot updates for release 0.17. + </action> + </release> + --> + <release version="0.1" date="2022-10-??" description="Initial release of Tentacles."> + <action issue="TENTACLES-16" type="add" dev="pottlinger"> + Initial infrastructure for changelogs added. + </action> + </release> + </body> +</document> diff --git a/changes/release-notes.vm b/changes/release-notes.vm new file mode 100644 index 0000000..73b6d97 --- /dev/null +++ b/changes/release-notes.vm @@ -0,0 +1,122 @@ +## 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} + RELEASE NOTES + +The ${developmentTeam} is pleased to announce the release of ${project.name} ${version} + +$introduction.replaceAll("(?<!\015)\012", " +").replaceAll("(?m)^ +","") + +## N.B. the available variables are described here: +## https://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("tentacles.jira.id").length()) +## e.g. indent1 = TENTACLES-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"," +")) +## Replace < with < so can embed tag markup +#set($action=$action.replaceAll("<","<")) +## use an empty date to mean don't format the entry +## TODO how to enable leading spaces without compromising html report +## unfortunately leading spaces are trimmed even from CDATA sections +#if ($actionItem.getDate() && $actionItem.getDate().length()==0) +$action +#else +## 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 +#end +#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}