Releaseflow

A Node.js command-line application for quickly creating all release files.

Why will it help me?

After a release build is ready for deployment, there are a lot of tasks to be completed. This program helps organize all those steps, and has various advantages over other deployment applications:

• Automatically:
  • Generates documentation, including information from the project's changelog
  • Builds the executable
  • Packs source code into a ZIP or TAR
• Compatible with Node.js and Maven, and many other project formats coming soon
  • Or, you can define your own XML or JSON file that can be used!
• Installable via npm

Where do I get it?

The application is installable via npm:
npm install -g releaseflow-cli

Enough talk. Let's see it in action!

Usage

Arguments

-V, --version        output the version number  
-l, --changelog      build changelog  
-d, --docs           build documentation template  
-e, --exec           build executable  
-c, --config <path>  set config path  
-s, --source         package source code  
-h, --help           output usage information  

rfconfig.json

All the configuration for your project is stored here, formatted as a JSON object. If the file does not exist, Releaseflow will auto-generate a template for you in your project's directory.

package: path to your project's descriptor (i.e. Node.js's `package.json`)  

markdown: whether to use markdown in documentation or not  

docs: information used when generating documentation  
	title: title of the document  
	dist: output folder path  
	template: create sections here you would like to appear in the documentation  

changelog: information used when generating the project's formatted changelog  
	path: input file  
	header_format: the format of each entry's header  
	replace_links: replace issue/pull request identifiers with actual links (i.e. `#1` is replaced by `[#1](https://www.github.com/user/repo/issues/1)`)  
	dist: output folder path  
	ignore: array of lines to ignore, such as a sign-off  

source: information used when compressing the source code  
	dir: array of glob strings (i.e. `*.txt`, `src/*.*`) of paths to files and folders that should be included  
	dist: output folder path  
	compression: array containing compression formats, either `zip` or `tar` (Note: tar's are also gzipped); there will be a file exported for each format specified  

exec: command used to build the project  

For the title and template sections in docs, as well as the dist property, project information may be interpolated into the contents by using the following identifiers:
%%changelog%: the project's generated, formatted changelog
%%toc%: table of contents

Any property present in the project's properties file (i.e. package.json, pom.xml) may be interpolated as well. Examples:
%%license%, %%artifactId%, %%version%, %%name%%

For the header_format property only, you can supply the following identifiers:
%n: integer
%s: string

For the 'dist' properties only, you can supply the following identifiers:
%e: default file extension (i.e. 'changelog-1.0.0.%e' would be 'changelog-1.0.0.md' if markdown is enabled)

An example header_format would look something like this:
(#%n)[%n/%n/%n-%n:%n %%version% %s] would be the formatted string for (#23)[4/2/2018-11:12 1.2.0 beta]

How can I help?

View the Contributing Guidelines for more information. The Releaseflow project is open to anyone and any code!

Slack

Request to join the Sergix team to recieve notifications on updates, Travis CI build status, and more!

Releaseflow v1.2.7
1.2.7
This project and its source are held under the GNU General Public License, located in the LICENSE file in the project's directory.
(c) 2018