Updated release note generation (markdown)
							parent
							
								
									9d92bb5fe6
								
							
						
					
					
						commit
						714d8a12e0
					
				| @ -1 +1,19 @@ | |||||||
| soon.jpg | ## default release notes | ||||||
|  | 
 | ||||||
|  | The default release notes are a changelog based on the [AngularJS Commit Message Conventions](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit). | ||||||
|  | 
 | ||||||
|  | ## custom release notes | ||||||
|  | 
 | ||||||
|  | If you want to generate your own release notes you can provide a generator in the `package.json`. | ||||||
|  | 
 | ||||||
|  | Add a `release` field and provide a path where `semantic-release` can require your it: | ||||||
|  | 
 | ||||||
|  | ```json | ||||||
|  | "release": { | ||||||
|  |   "notes": "./lib/custom-release-notes" | ||||||
|  | } | ||||||
|  | ``` | ||||||
|  | 
 | ||||||
|  | The module should export a function that calls the provided callback (the last and currently only argument) with an error object or `null` as the first argument and the release notes(string) as the second argument.  | ||||||
|  | 
 | ||||||
|  | Have a look at [the default generator](https://github.com/boennemann/semantic-release/blob/master/lib/release-notes.js) for a sample implementation. | ||||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user