Skip to content

A handy tool that help to write release/chagne log from git commit message

License

Notifications You must be signed in to change notification settings

TheDevsTech/awesome-release-logger

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

62 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

📋Awesome release logger📋

A handy tool that help to write release/change log from git commit message

Development

  • Requirement

    • Go >= 1.12
  • Clone the repo

    git clone https://github.com/TheDevsTech/awesome-release-logger.git
    cd awesome-release-logger
    
  • Build make or go build -o bin/ar-logger main.go

Cross Platform Build

  • Cross compilation is hard, and docker is help us in that way! Install docker and pull docker image docker pull karalabe/xgo-latest and install a go package go get github.com/karalabe/xgo
  • For build most of the platforms binary use
    xgo github.com/TheDevsTech/awesome-release-logger
    
  • Or specific platform
    xgo --targets=linux/amd64 github.com/TheDevsTech/awesome-release-logger
    
  • After build is finished you should have all platforms binary in your current directory.
  • More build details find here

Installation

  • after build or download the binary just move it to /usr/local/bin i.e: mv bin/ar-logger /usr/local/bin/arl
  • restart your shell
  • verify installation which arl output should be /usr/local/bin/arl

Usage

  • type arl -h in terminal for help. You should get below output
    Usage of arl:
      -b	get logs from the beginning
      -d string
            project directory path (default ".")
      -n	write new release log file
      -o string
            output file path (default ".")
      -v	show the version number
  • Generate release log
    • go to your project directory and type arl there
    • Or you can run arl command from anywhere and point your project directory like this arl -d <project_directory_path
    • By default release-log.md file will generate in current directory. If you want it to other location then arl -o <output_directory_path
    • By default this logger prepend logs if file exists. If you need separate file just pass -n flag i.e: arl -n
    • By default this logger get commit logs between latest tag & HEAD(if tag doesn't exists then its get from the beginning)
    • If tags are exists and you want to generate a fresh log from the beginning then ad -b flag i.e arl -b
  • Conventional Commits
    • For proper release log you must follow conventonal commit types in your commit message
    • The commit message should be structured as follows:
      <type>[optional scope]: <description>
      
    • Commit types
      • fix: a commit of the type fix patches a bug in your codebase (this correlates with PATCH in semantic versioning).
      • feat: a commit of the type feat introduces a new feature to the codebase (this correlates with MINOR in semantic versioning).
      • breaking change: a commit that has a footer BREAKING CHANGE:, or appends a ! after the type/scope, introduces a breaking API change (correlating with MAJOR in semantic versioning).A breaking change can be part of commits of any type. e.g., a fix:, feat: & chore: types would all be valid, in addition to any other type.
      • chore: Update something without impacting the user (ex: bump a dependency in package.json).
      • For more details here

License

GPL-3.0