Skip to content

Commit

Permalink
docs: update release notes
Browse files Browse the repository at this point in the history
  • Loading branch information
jeremylong committed Oct 21, 2024
1 parent 2b36c82 commit ab479cf
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 13 deletions.
28 changes: 28 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,33 @@
# Change Log

## [Version 11.0.0](https://github.com/jeremylong/DependencyCheck/releases/tag/v11.0.0) (2024-10-21)

- **breaking change**: Switch from JMockit to Mockito & build target to Java 11 (#6922)
- dependency-check now requires a minimum of Java 11.0 to run
- **breaking change**: bump com.h2database:h2 from 2.1.214 to 2.3.232 (#6132)
- H2 databases generated with an older version of ODC will not work with ODC 11.0.0; a new H2 db must be generated
- feat: Replace old Downloader by an Apache HTTPClient based downloader
- feat: Use Apache HTTPClient for downloads of public resources (#6949)
- feat: Also make NodeAuditSearch usr our HTTPClient based connections
- feat: Also make OSSIndexAnalyzer use our HTTPClient based connections
- feat: Migrate CentralSearch to use Apache HTTP-client via Downloader
- feat: Extend apache HTTP-client usage to EngineVersionCheck
- feat: Remove the need to specify dbDriver for external databases using JDBCv4 ServiceLoader supporting JDBC drivers (#6938)
- fix: use latest generated suppressions (#7064)
- fix: Fixup parameter sequence for Dowloader credentials (#7033)
- fix: Fixup the missing addition of NVD API Datafeed credentials (if configured)
- fix: Fixup broken proxy authentication in first attempt; extend to include KEV downloads
- fix: store timestamps locally for local resources (#6936)
- build: Remove the animal-sniffer, propagate java version to plugin-archetype (#6950)
- build: Update Checkstyle configuration and Suppression DTD references (#6951)
- chore: Update test db schema (#7036)
- chore: remove old, unneeded database upgrade script
- docs: reformat javadoc (#7009)
- docs: Fixup javadoc warnings (#6995)
- chore: Replace use of several deprecated methods/classes by their successors (#6933)

See the full listing of [changes](https://github.com/jeremylong/DependencyCheck/milestone/87?closed=1).

## [Version 10.0.4](https://github.com/jeremylong/DependencyCheck/releases/tag/v10.0.4) (2024-09-01)

- build(deps): exclude unused dependency (#6916)
Expand Down
29 changes: 16 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,21 @@ Documentation and links to production binary releases can be found on the [githu

This product uses the NVD API but is not endorsed or certified by the NVD.


## Breaking Changes in 11.0.0

- Java 11 is now required to run dependency-check 11.0.0 or higher
- H2 database upgrade

11.0.0 contains breaking changes using the local H2 database. A full download
of the NVD data will occur. Note that if you are using a shared data directory
the h2 database file is not compatible with older versions of dependency-check.
If you run into problems you may need to run a purge:

- gradle: `./gradlew dependencyCheckPurge`
- maven: `mvn org.owasp:dependency-check-maven:9.0.0:purge`
- cli: `dependency-check.sh --purge`

## Mandatory Upgrade Notice

**Upgrading to 10.0.2 or later is mandatory**
Expand All @@ -35,18 +50,6 @@ The NVD API has enforced rate limits. If you are using a single API KEY and
multiple builds occur you could hit the rate limit and receive 403 errors. In
a CI environment one must use a caching strategy.


### Breaking Changes

9.0.0 contains breaking changes which requires updates to the database. If using
an externally hosted database the schema will need to be updated. When using the
embedded H2 database, the schema should be upgraded automatically. However, if
issues arise you may need to purge the database:

- gradle: `./gradlew dependencyCheckPurge`
- maven: `mvn org.owasp:dependency-check-maven:9.0.0:purge`
- cli: `dependency-check.sh --purge`

#### Gradle build Environment

With 9.0.0 users may encounter issues with `NoSuchMethodError` exceptions due to
Expand Down Expand Up @@ -171,7 +174,7 @@ For instructions on the use of the Ant Task, please see the [dependency-check-an
## Development Prerequisites

For installation to pass, you must have the following components installed:
* Java: `java -version` 1.8
* Java: `java -version` 11.0
* Maven: `mvn -version` 3.5.0 and higher

Tests cases require:
Expand Down

0 comments on commit ab479cf

Please sign in to comment.