Skip to content

Commit

Permalink
Prepare for the next release candidate
Browse files Browse the repository at this point in the history
  • Loading branch information
@garydgregory
garydgregory committed Jul 13, 2024
1 parent 2d95820 commit a7333c0
Show file tree
Hide file tree
Showing 5 changed files with 95 additions and 22 deletions.
9 changes: 4 additions & 5 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,8 @@
Contributing to Apache Commons BCEL
======================

You have found a bug or you have an idea for a cool new feature? Contributing code is a great way to give something back to
the open source community. Before you dig right into the code there are a few guidelines that we need contributors to
follow so that we can have a chance of keeping on top of things.
Have you found a bug or have an idea for a cool new feature? Contributing code is a great way to give something back to the open-source community.
Before you dig right into the code, we need contributors to follow a few guidelines to have a chance of keeping on top of things.

Getting Started
---------------
Expand All @@ -62,7 +61,7 @@ Making Changes

+ Create a _topic branch_ for your isolated work.
* Usually you should base your branch on the `master` branch.
* A good topic branch name can be the JIRA bug id plus a keyword, e.g. `BCEL-123-InputStream`.
* A good topic branch name can be the JIRA bug ID plus a keyword, e.g. `BCEL-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.
Expand All @@ -72,7 +71,7 @@ Making Changes
+ 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.
+ Check for unnecessary whitespace with `git diff` -- check before committing.
+ Make sure you have added the necessary tests for your changes, typically in `src/test/java`.
+ Run all the tests with `mvn clean verify` to assure nothing else was accidentally broken.
+ Run all the tests with `mvn clean verify` to ensure nothing else was accidentally broken.

Making Trivial Changes
----------------------
Expand Down
8 changes: 5 additions & 3 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Apache Commons BCEL

[![Java CI](https://github.com/apache/commons-bcel/actions/workflows/maven.yml/badge.svg)](https://github.com/apache/commons-bcel/actions/workflows/maven.yml)
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.apache.bcel/bcel/badge.svg?gav=true)](https://maven-badges.herokuapp.com/maven-central/org.apache.bcel/bcel/?gav=true)
[![Javadocs](https://javadoc.io/badge/org.apache.bcel/bcel/6.9.0.svg)](https://javadoc.io/doc/org.apache.bcel/bcel/6.9.0)
[![Javadocs](https://javadoc.io/badge/org.apache.bcel/bcel/6.10.0.svg)](https://javadoc.io/doc/org.apache.bcel/bcel/6.10.0)
[![CodeQL](https://github.com/apache/commons-bcel/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/apache/commons-bcel/actions/workflows/codeql-analysis.yml)
[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/apache/commons-bcel/badge)](https://api.securityscorecards.dev/projects/github.com/apache/commons-bcel)

Expand All @@ -68,7 +68,7 @@ Alternatively, you can pull it from the central Maven repositories:
<dependency>
<groupId>org.apache.bcel</groupId>
<artifactId>bcel</artifactId>
<version>6.9.0</version>
<version>6.10.0</version>
</dependency>
```

Expand All @@ -88,7 +88,9 @@ There are some guidelines which will make applying PRs easier for us:
+ No tabs! Please use spaces for indentation.
+ 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```.
+ 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`

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).
Expand Down
72 changes: 72 additions & 0 deletions RELEASE-NOTES.txt
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,75 @@
Apache Commons BCEL Version 6.10.0
RELEASE NOTES


Introduction
------------
The Apache Commons BCEL team is pleased to announce the release of
Apache Commons BCEL 6.10.0.

The Byte Code Engineering Library (BCEL) is intended to give users a convenient
way to analyze, create, and manipulate compiled .class files. Classes are
represented by objects containing all the symbolic information of the given
class: methods, fields, and byte code instructions.

Maintenance and bug fix release. Requires a minimum of Java 8.

Changes
-------
* Fix PMD UnnecessaryFullyQualifiedName. Thanks to Gary Gregory.
* Fix PMD EmptyCatchBlock by allowing commented blocks. Thanks to Gary Gregory.
* Fix PMD EmptyControlStatement by allowing commented blocks. Thanks to Gary Gregory.
* Fix SpotBugs RV_RETURN_VALUE_IGNORED_BAD_PRACTICE in JasminVisitor. Thanks to Gary Gregory.
* SpotBugs checks should ignore code generated by JavaCC. Thanks to Gary Gregory.
* Fix SpotBugs URF_UNREAD_FIELD in ClassDumper. Thanks to Gary Gregory.
* Fix SpotBugs DM_DEFAULT_ENCODING in JasminVisitor. Thanks to Gary Gregory.
* Fix SpotBugs RCN_REDUNDANT_NULLCHECK_WOULD_HAVE_BEEN_A_NPE in ASTFunAppl. Thanks to Gary Gregory.
* Fix SpotBugs RV_ABSOLUTE_VALUE_OF_HASHCODE in Mini.Environment. Thanks to Gary Gregory.
* Fix SpotBugs DM_DEFAULT_ENCODING in Mini.MiniC. Thanks to Gary Gregory.
* Fix SpotBugs WMI_WRONG_MAP_ITERATOR in Package.go(String[]). Thanks to Gary Gregory.
* Deprecate TransitiveHull.INGORED in favor of TransitiveHull.getIgnored(). Thanks to Gary Gregory.
* Add accessors to model and unit tests, Javadoc #183. Thanks to nbauma109, Gary Gregory, Mark Roberts.
* Add Const.MAJOR_22. Thanks to Gary Gregory.
* Add Const.MINOR_22. Thanks to Gary Gregory.
* Add Const.MAJOR_23. Thanks to Gary Gregory.
* Add Const.MINOR_23. Thanks to Gary Gregory.
* Add Const.MAJOR_24. Thanks to Gary Gregory.
* Add Const.MINOR_24. Thanks to Gary Gregory.
* Bump tests from org.assertj:assertj-core 3.25.3 to 3.26.3 #322, #332. Thanks to Dependabot.
* Bump tests from org.jetbrains.kotlin:kotlin-stdlib 1.9.23 to 2.0.0 #309, #318. Thanks to Dependabot.
* Bump tests from org.apache.commons:commons-collections4 4.4 to 4.5.0-M2. Thanks to Gary Gregory.
* Bump org.apache.commons:commons-parent from 69 to 71. Thanks to Gary Gregory.
* Bump org.codehaus.mojo:taglist-maven-plugin from 3.0.0 to 3.1.0 #331. Thanks to Gary Gregory.


Historical list of changes: https://commons.apache.org/proper/commons-bcel/changes-report.html

For complete information on Apache Commons BCEL, including instructions on how to submit bug reports,
patches, or suggestions for improvement, see the Apache Commons BCEL website:

https://commons.apache.org/proper/commons-bcel

Download it from https://commons.apache.org/proper/commons-bcel/download_bcel.cgi

Have fun!
-Apache Commons BCEL team

Feedback
--------
Open source works best when you give feedback:

https://commons.apache.org/bcel

Please direct all bug reports to JIRA:

https://issues.apache.org/jira/browse/BCEL

Or subscribe to the commons-user mailing list

The Apache Commons Team

-----------------------------------------------------------------------------

Apache Commons BCEL Version 6.9.0
RELEASE NOTES

Expand Down
2 changes: 1 addition & 1 deletion src/changes/changes.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ The <action> type attribute can be add,update,fix,remove.
Defining changes.version allows one to create the RN without first removing the SNAPSHOT suffix.
-->
<body>
<release version="6.10.0" date="YYYY-MM-DD" description="Maintenance and bug fix release. Requires a minimum of Java 8.">
<release version="6.10.0" date="2024-07-13" description="Maintenance and bug fix release. Requires a minimum of Java 8.">
<!-- FIX -->
<action type="update" dev="ggregory" due-to="Gary Gregory">Fix PMD UnnecessaryFullyQualifiedName.</action>
<action type="update" dev="ggregory" due-to="Gary Gregory">Fix PMD EmptyCatchBlock by allowing commented blocks.</action>
Expand Down
26 changes: 13 additions & 13 deletions src/site/xdoc/download_bcel.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -113,32 +113,32 @@ limitations under the License.
</p>
</subsection>
</section>
<section name="Apache Commons BCEL 6.9.0 (Java 8 or above)">
<section name="Apache Commons BCEL 6.10.0 (Java 8 or above)">
<subsection name="Binaries">
<table>
<tr>
<td><a href="[preferred]/commons/bcel/binaries/bcel-6.9.0-bin.tar.gz">bcel-6.9.0-bin.tar.gz</a></td>
<td><a href="https://downloads.apache.org/commons/bcel/binaries/bcel-6.9.0-bin.tar.gz.sha512">sha512</a></td>
<td><a href="https://downloads.apache.org/commons/bcel/binaries/bcel-6.9.0-bin.tar.gz.asc">pgp</a></td>
<td><a href="[preferred]/commons/bcel/binaries/bcel-6.10.0-bin.tar.gz">bcel-6.10.0-bin.tar.gz</a></td>
<td><a href="https://downloads.apache.org/commons/bcel/binaries/bcel-6.10.0-bin.tar.gz.sha512">sha512</a></td>
<td><a href="https://downloads.apache.org/commons/bcel/binaries/bcel-6.10.0-bin.tar.gz.asc">pgp</a></td>
</tr>
<tr>
<td><a href="[preferred]/commons/bcel/binaries/bcel-6.9.0-bin.zip">bcel-6.9.0-bin.zip</a></td>
<td><a href="https://downloads.apache.org/commons/bcel/binaries/bcel-6.9.0-bin.zip.sha512">sha512</a></td>
<td><a href="https://downloads.apache.org/commons/bcel/binaries/bcel-6.9.0-bin.zip.asc">pgp</a></td>
<td><a href="[preferred]/commons/bcel/binaries/bcel-6.10.0-bin.zip">bcel-6.10.0-bin.zip</a></td>
<td><a href="https://downloads.apache.org/commons/bcel/binaries/bcel-6.10.0-bin.zip.sha512">sha512</a></td>
<td><a href="https://downloads.apache.org/commons/bcel/binaries/bcel-6.10.0-bin.zip.asc">pgp</a></td>
</tr>
</table>
</subsection>
<subsection name="Source">
<table>
<tr>
<td><a href="[preferred]/commons/bcel/source/bcel-6.9.0-src.tar.gz">bcel-6.9.0-src.tar.gz</a></td>
<td><a href="https://downloads.apache.org/commons/bcel/source/bcel-6.9.0-src.tar.gz.sha512">sha512</a></td>
<td><a href="https://downloads.apache.org/commons/bcel/source/bcel-6.9.0-src.tar.gz.asc">pgp</a></td>
<td><a href="[preferred]/commons/bcel/source/bcel-6.10.0-src.tar.gz">bcel-6.10.0-src.tar.gz</a></td>
<td><a href="https://downloads.apache.org/commons/bcel/source/bcel-6.10.0-src.tar.gz.sha512">sha512</a></td>
<td><a href="https://downloads.apache.org/commons/bcel/source/bcel-6.10.0-src.tar.gz.asc">pgp</a></td>
</tr>
<tr>
<td><a href="[preferred]/commons/bcel/source/bcel-6.9.0-src.zip">bcel-6.9.0-src.zip</a></td>
<td><a href="https://downloads.apache.org/commons/bcel/source/bcel-6.9.0-src.zip.sha512">sha512</a></td>
<td><a href="https://downloads.apache.org/commons/bcel/source/bcel-6.9.0-src.zip.asc">pgp</a></td>
<td><a href="[preferred]/commons/bcel/source/bcel-6.10.0-src.zip">bcel-6.10.0-src.zip</a></td>
<td><a href="https://downloads.apache.org/commons/bcel/source/bcel-6.10.0-src.zip.sha512">sha512</a></td>
<td><a href="https://downloads.apache.org/commons/bcel/source/bcel-6.10.0-src.zip.asc">pgp</a></td>
</tr>
</table>
</subsection>
Expand Down

0 comments on commit a7333c0

Please sign in to comment.