Cynosphere/bcv-vf
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Merge pull request #302 from ThexXTURBOXx/master

Browse source 
Document dependency release process
This commit is contained in:
Kalen (Konloch) Kinloch 2021-06-22 12:25:44 -07:00 committed by GitHub
commit b614b30b60
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
libs/README.md Normal file
View file

@ -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).