Skip to content

Commit

Permalink
Merge pull request #3 from justcoded/develop
Browse files Browse the repository at this point in the history
Renamed config/gitflow commands
  • Loading branch information
aprokopenko committed May 13, 2022
2 parents 25269f9 + 20fc859 commit 87114a3
Show file tree
Hide file tree
Showing 6 changed files with 53 additions and 3 deletions.
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
---
<!--- END HEADER -->

## [1.1.0](https://github.com/justcoded/git-extras/compare/v1.0.0...v1.1.0) (2022-05-13)
### Features

* Renamed config/gitflow commands prefix


---

## [1.0.0]() (2022-05-09)
### Features

Expand Down
26 changes: 25 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -1,8 +1,32 @@
.PHONY: default install
.PHONY: default install uninstall chl chl-first

default:
@echo 'Git extras installation helper from JustCoded'

install:
sudo cp -f ./bin/* /usr/local/bin/
sudo chmod +x /usr/local/bin/git-*

uninstall:
sudo rm /usr/local/bin/git-*

##
# CHANGELOG vars and targets
##
CONV_CHL_IMAGE := justcoded/php-conventional-changelog:latest
CONV_CHL_DR := docker run -it --rm --volume "$$PWD":/codebase ${CONV_CHL_IMAGE} bash
CONV_CHL_CMD := conventional-changelog --config changelog-config.php

##
# @command chl Generate changelog based on conventional commits
##
chl:
${CONV_CHL_DR} \
-c "${CONV_CHL_CMD}"

##
# @command chl-first Generate changelog based on conventional commits, first version
##
chl-first:
${CONV_CHL_DR} \
-c "${CONV_CHL_CMD} --first-release"
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ make install
| Command | Description |
|-------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------|
| `git browse` | Opens remote repository URL in browser. Taken from [git-extras](https://github.com/tj/git-extras). |
| `git jc-config` | Configures repository with default global filemode (or 'false' by default) and push strategy. |
| `git jc-gitflow` | Creates if not exists `develop`/`release` branches or sync them. |
| `git set-config` | Configures repository with default global filemode (or 'false' by default) and push strategy. |
| `git set-gitflow` | Creates if not exists `develop`/`release` branches or sync them. |
| `git jc-feature <shortDescription>` | Defines git branching flow ("gitflow" or "feature branch") and creates Feature branch from the right branch (develop or main/master) |
| `git jc-hotfix <shortDescription>` | Creates Hotfix branch from `main`/`master` branch. |
| `git lk-feature <shortDescription>` | Creates Feature branch from `release`. |
Expand Down
File renamed without changes.
File renamed without changes.
18 changes: 18 additions & 0 deletions changelog-config.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<?php
/**
* @see: https://github.com/marcocesarato/php-conventional-changelog/blob/main/docs/config.md
*/

return [
'path' => 'CHANGELOG.md',
'headerTitle' => 'Changelog',
'headerDescription' => 'All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
---',
'ignoreTypes' => ['build', 'chore', 'ci', 'docs', 'perf', 'refactor', 'revert', 'style', 'test', 'bug'],

'hiddenHash' => true,
];

0 comments on commit 87114a3

Please sign in to comment.