From 98e1719f10740d0a37e78f758a2c3557a1f2b52f Mon Sep 17 00:00:00 2001 From: Nico Mexis Date: Tue, 22 Jun 2021 21:21:10 +0200 Subject: [PATCH] Document dependency release process --- libs/README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 libs/README.md diff --git a/libs/README.md b/libs/README.md new file mode 100644 index 00000000..4c5bcae1 --- /dev/null +++ b/libs/README.md @@ -0,0 +1,18 @@ +### Welcome! You have reached the `libs` folder! + +#### Adding new dependencies + +Run the following command (replacing the placeholder first of course!): +```console +mvn deploy:deploy-file -DgroupId=[GROUP-ID] -DartifactId=[ARTIFACT-ID] -Dversion=[VERSION] -Durl=file:. -DrepositoryId=local-maven-repo -DupdateReleaseInfo=true -Dfile=[THE-JAR-FILE] +``` + +#### Updating dependencies + +Just do the same procedure as in "Adding new dependencies", but with a new version number! + +You can also safely delete the old version of the dependency, as nothing will depend on it anymore. + +#### Why the suffix `bcv`? + +Some dependencies may have been modified or could be released by their author in the future. To avoid confusion and dependency clashes in the local repository, the suffix is a nice way to ensure, the right dependency is used in every project (`bcv` = `ByteCode Viewer` btw).