This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-skin.git
The following commit(s) were added to refs/heads/master by this push: new e554932 Prepare for the next release candidate e554932 is described below commit e5549320eeb92bab61268027c362b430feead771 Author: Gary D. Gregory <garydgreg...@gmail.com> AuthorDate: Sat Sep 13 13:08:02 2025 +0000 Prepare for the next release candidate --- CONTRIBUTING.md | 4 ++-- README.md | 9 ++++++--- RELEASE-NOTES.txt | 45 +++++++++++++++++++++++++++++++++++++++++++++ src/changes/changes.xml | 2 +- 4 files changed, 54 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ba09654..04c81f6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -61,11 +61,11 @@ Making Changes + Create a _topic branch_ for your isolated work. * Usually you should base your branch from the `master` branch. - * A good topic branch name can be the JIRA bug ID plus a keyword, for example, `COMMONSSITE-123-InputStream`. + * A good topic branch name can be the JIRA bug ID plus a keyword, e.g. `COMMONSSITE-123-InputStream`. * If you have submitted multiple JIRA issues, try to maintain separate branches and pull requests. + Make commits of logical units. * Make sure your commit messages are meaningful and in the proper format. Your commit message should contain the key of the JIRA issue. - * For example, `[COMMONSSITE-123] Close input stream earlier` + * For example, `[COMMONSSITE-123] Close input stream sooner` + Respect the original code style: + Only use spaces for indentation; you can check for unnecessary whitespace with `git diff` before committing. + Create minimal diffs - disable _On Save_ actions like _Reformat Source Code_ or _Organize Imports_. If you feel the source code should be reformatted create a separate PR for this change first. diff --git a/README.md b/README.md index acf746b..cf8708e 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,9 @@ Apache Commons Skin [](https://github.com/apache/commons-skin/actions/workflows/maven.yml) [](https://search.maven.org/artifact/org.apache.commons/commons-skin) +[](https://javadoc.io/doc/org.apache.commons/commons-skin/5.1.0) +[](https://github.com/apache/commons-skin/actions/workflows/codeql-analysis.yml) +[](https://api.securityscorecards.dev/projects/github.com/apache/commons-skin) Apache Commons Skin @@ -65,7 +68,7 @@ Alternatively, you can pull it from the central Maven repositories: <dependency> <groupId>org.apache.commons</groupId> <artifactId>commons-skin</artifactId> - <version>5.0.0</version> + <version>5.1.0</version> </dependency> ``` @@ -86,8 +89,8 @@ There are some guidelines which will make applying PRs easier for us: + Respect the existing code style for each file. + Create minimal diffs - disable on save actions like reformat source code or organize imports. If you feel the source code should be reformatted create a separate PR for this change. + Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running `mvn`. -+ Before you pushing a PR, run `mvn` (by itself), this runs the default goal, which contains all build checks. -+ To see the code coverage report, regardless of coverage failures, run `mvn clean site -Dcommons.jacoco.haltOnFailure=false` ++ Before you push a PR, run `mvn` (without arguments). This runs the default goal which contains all build checks. ++ To see the code coverage report, regardless of coverage failures, run `mvn clean site -Dcommons.jacoco.haltOnFailure=false -Pjacoco` If you plan to contribute on a regular basis, please consider filing a [contributor license agreement](https://www.apache.org/licenses/#clas). You can learn more about contributing via GitHub in our [contribution guidelines](CONTRIBUTING.md). diff --git a/RELEASE-NOTES.txt b/RELEASE-NOTES.txt index d98c203..420f42e 100644 --- a/RELEASE-NOTES.txt +++ b/RELEASE-NOTES.txt @@ -1,3 +1,48 @@ +Apache Commons Skin 5.1.0 Release Notes +--------------------------------------- + +The Apache Commons Skin team is pleased to announce the release of Apache Commons Skin 5.1.0. + +New features and bug fixes. + +Changes in this version include: + + +Fixed Bugs: +o Fix typo in site.vm +o Remove -nouses directive from maven-bundle-plugin. OSGi package imports now state 'uses' definitions for package imports, this doesn't affect JPMS (from org.apache.commons:commons-parent:80). Thanks to Gary Gregory. + +Changes: +o Bump commons-parent from 79 to 87 #211, #232. Thanks to Dependabot, Gary Gregory. +o Use the new oak leaf logo, needs a new commons-parent even for this component. Thanks to Gary Gregory. + + + +You can test Apache Commons Skin by installing the skin using 'mvn install' +and adding the following to your site.xml site descriptor for the maven-site-plugin: + + <skin> + <groupId>org.apache.commons</groupId> + <artifactId>commons-skin</artifactId> + <version>5.1.0</version> + </skin> + + <custom> + <!-- Custom properties controlling the commons-skin template. --> + <commonsSkin> + <!-- + Convert preformatted source section tags to prettyprint: + <div class="source"><pre> to <div class="source"><pre class="prettyprint"> + --> + <prettyPrintSourcePreTags>true</prettyPrintSourcePreTags> + + <!-- Add the "linenums" class to the prettyprint enabled source tags --> + <prettyPrintLineNumbersEnabled>false</prettyPrintLineNumbersEnabled> + </commonsSkin> + </custom> + +----------------------------------------------------------------------------- + Apache Commons Skin 5.0.0 RELEASE NOTES diff --git a/src/changes/changes.xml b/src/changes/changes.xml index 686a26c..6a29977 100644 --- a/src/changes/changes.xml +++ b/src/changes/changes.xml @@ -58,7 +58,7 @@ The <action> type attribute can be add,update,fix,remove. The changes report outputs actions in the order they appear in this file. --> <body> - <release version="5.1.0" date="YYYY-MM-DD" description="New features and bug fixes."> + <release version="5.1.0" date="2025-09-13" description="New features and bug fixes."> <!-- FIX --> <action type="fix" dev="sebb">Fix typo in site.vm</action> <action type="fix" dev="ggregory" due-to="Gary Gregory">Remove -nouses directive from maven-bundle-plugin. OSGi package imports now state 'uses' definitions for package imports, this doesn't affect JPMS (from org.apache.commons:commons-parent:80).</action>