Merge pull request #302 from ThexXTURBOXx/master
Document dependency release process
This commit is contained in:
		
						commit
						b614b30b60
					
				
					 1 changed files with 18 additions and 0 deletions
				
			
		
							
								
								
									
										18
									
								
								libs/README.md
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										18
									
								
								libs/README.md
									
										
									
									
									
										Normal 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).
 | 
			
		||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue