From a0c57039385b4eb15f54992bf8fb5b382b689d9c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Michael=20Vorburger=20=E2=9B=91=EF=B8=8F?= Date: Tue, 19 May 2020 22:51:55 +0200 Subject: [PATCH] add new Dependency Upgrades section to README --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index bdffaf03db2..1c16a23bd9f 100644 --- a/README.md +++ b/README.md @@ -291,6 +291,15 @@ them in different commits. This helps review to review your code faster. We have an automated Bot which marks pull requests as "stale" after a while, and ultimately automatically closes them. +Dependency Upgrades +------------------- + +This project uses a number of 3rd-party libraries, and this section provides some guidance for their updates. We have set-up [Renovate's bot](https://renovate.whitesourcesoftware.com) to automatically raise Pull Requests for our review when new dependencies are available [FINERACT-962](https://issues.apache.org/jira/browse/FINERACT-962). + +Upgrades sometimes require package name changes. Changed code should ideally have test coverage. + +Our `ClasspathHellDuplicatesCheckRuleTest` detects classes that appear in more than 1 JAR. If a version bump in [`build.gradle`](https://github.com/search?q=repo%3Aapache%2Ffineract+filename%3Abuild.gradle&type=Code&ref=advsearch&l=&l=) causes changes in transitives dependencies, then you may have to add related `exclude` to our [`dependencies.gradle`](https://github.com/apache/fineract/search?q=dependencies.gradle). Running `./gradlew dependencies` helps to understand what is required. + Releasing ---------