Merge pull request #15 from nkmr-jp/develop

Develop

Author: nkmr-jp

.github/workflows/release.yml

@@ -30,7 +30,7 @@ jobs:
       - name: Generate semantic-release configs
         working-directory: ./gitmoji-semver
         run: |
-          make scaffold V=v3.0.0 F=../.semver.yml O=.. T=simple
+          make scaffold F=../.semver.yml O=..
       - name: Release
         working-directory: ./.release
         env:

.semver.yml

@@ -1,75 +1,14 @@
 # Release Branches
 branches: [ master, main ]
 
-# gitmoji semver settings (default is none)
+# gitmoji semver settings
+# You can override the default values to suit your project.
 semver:
-  major:
-    - boom      # Introduce breaking changes.
-
-  minor:
-    - sparkles  # Introduce new features.
-    - lipstick  # Add or update the UI and style files.
-    - tada      # Begin a project.
-    - globe_with_meridians  # Internationalization and localization.
-    - bento                 # Add or update assets.
-    - wheelchair            # Improve accessibility.
-    - children_crossing     # Improve user experience / usability.
-    - iphone    # Work on responsive design.
-    - egg       # Add or update an easter egg.
-    - triangular_flag_on_post   # Add, update, or remove feature flags.
-    - dizzy     # Add or update animations and transitions.
-
-  patch:
-    - art   # Improve structure / format of the code.
-    - zap   # Improve performance.
-    - fire  # Remove code or files.
-    - bug   # Fix a bug.
-    - ambulance         # Critical hotfix.
-    - white_check_mark  # Add or update tests.
-    - lock              # Fix security issues.
-    - rotating_light    # Fix compiler / linter warnings.
-    - green_heart       # Fix CI Build.
-    - arrow_down        # Downgrade dependencies.
-    - arrow_up          # Upgrade dependencies.
-    - pushpin           # Pin dependencies to specific versions.
-    - construction_worker       # Add or update CI build system.
-    - chart_with_upwards_trend  # Add or update analytics or track code.
-    - recycle           # Refactor code.
-    - heavy_plus_sign   # Add a dependency.
-    - heavy_minus_sign  # Remove a dependency.
-    - wrench            # Add or update configuration files.
-    - hammer            # Add or update development scripts.
-    - package           # Add or update compiled files or packages.
-    - alien             # Update code due to external API changes.
-    - truck             # Move or rename resources (e.g.: files, paths, routes).
-    - page_facing_up    # Add or update license.
-    - card_file_box     # Perform database related changes.
-    - loud_sound        # Add or update logs.
-    - mute              # Remove logs.
-    - building_construction     # Make architectural changes.
-    - mag       # Improve SEO.
-    - label     # Add or update types.
-    - goal_net  # Catch errors.
-
-  none:
-    - memo      # Add or update documentation.
-    - rocket    # Deploy stuff.
-    - bookmark  # Release / Version tags.
-    - pencil2   # Fix typos.
-    - poop      # Write bad code that needs to be improved.
-    - rewind    # Revert changes.
-    - twisted_rightwards_arrows     # Merge branches.
-    - bulb                  # Add or update comments in source code.
-    - beers                 # Write code drunkenly.
-    - speech_balloon        # Add or update text and literals.
-    - busts_in_silhouette   # Add or update contributor(s).
-    - clown_face    # Mock things.
-    - see_no_evil   # Add or update a .gitignore file.
-    - camera_flash  # Add or update snapshots.
-    - alembic       # Perform experiments.
-    - seedling      # Add or update seed files.
-    - wastebasket   # Deprecate code that needs to be cleaned up.
-
-  # not add in release-template.hbs
-  ignore:
+#  minor:
+#    - lipstick
+#  patch:
+#    - art
+#  none: # gitmoji.json `"semver": null` is convert to none
+#    - pencil2
+  ignore: # not add in release-template.hbs
     - construction  # Work in progress.

Makefile

@@ -1,12 +1,10 @@
 # Options
-V=v3.0.0
+V=v3.2.0
 GITMOJI_VERSION=$(V)
 F=.semver.yml
 SEMVER_FILE=$(F)
 O=./
 OUT_DIR=$(O)
-T=""
-TEMPLATE_TYPE=$(T)
 
 BASE_FILE=https://raw.githubusercontent.com/carloscuesta/gitmoji/$(GITMOJI_VERSION)/src/data/gitmojis.json
 
@@ -40,10 +38,9 @@ help:
 	@echo "    T=<template type>	$(BLUE)Specify release template type 'default or simple'$(RESET)"
 	@echo
 	@echo "$(GREEN)Examples:$(RESET)"
-	@echo "    make gen V=v3.0.0 F=./.semver.yml"
+	@echo "    make gen F=./.semver.yml"
 	@echo "    make list"
-	@echo "    make scaffold V=v3.0.0 F=./.semver.yml O=./.playground"
-	@echo "    make scaffold V=v3.0.0 F=./.semver.yml O=./.playground T=simple"
+	@echo "    make scaffold F=./.semver.yml O=./.playground"
 	@echo
 
 # Generate gitmojis.json with semver field
@@ -55,17 +52,14 @@ gen:
 
 	@echo
 	@echo
-	@echo "$(PURPLE)# GEN: 2. Add semver field$(RESET)"
+	@echo "$(PURPLE)# GEN: 2. Update semver field$(RESET)"
 	yq '.' $(SEMVER_FILE) > build/src/semver.json
 	node gitmoji-semver.js
-	cat build/dist/tmp.json | jq > build/dist/gitmojis.json
-	yq -y '.' build/dist/gitmojis.json > build/dist/gitmojis.yml
-	rm build/dist/tmp.json
 
 	@echo
 	@echo
-	@echo "$(PURPLE)# GEN: 3. Generated!$(RESET)"
-	@echo "Generated gitmojis.json and gitmojis.yml with semver field"
+	@echo "$(PURPLE)# GEN: 4. Generated!$(RESET)"
+	@echo "Generated gitmojis.json and semver.json"
 	@echo "See ./build/dist"
 
 	@echo
@@ -91,17 +85,13 @@ list:
 scaffold: gen
 	@echo
 	@echo "$(PURPLE)# SCAFFOLD: Generate semantic-release setting files$(RESET)"
-	node gen-release-template.js $(TEMPLATE_TYPE)
+	node gen-release-template.js
 	mkdir -p $(OUT_DIR)/.release
 	cp -a ./semantic-release-template/. $(OUT_DIR)/.release
 	cp ./build/dist/release-template.hbs $(OUT_DIR)/.release
 	cp ./build/dist/gitmojis.json $(OUT_DIR)/.release
-	cp ./build/src/semver.json $(OUT_DIR)/.release
-ifeq ($(TEMPLATE_TYPE),simple)
-	cp $(OUT_DIR)/.release/commit-template-simple.hbs $(OUT_DIR)/.release/commit-template.hbs
-else
-	cp $(OUT_DIR)/.release/commit-template-default.hbs $(OUT_DIR)/.release/commit-template.hbs
-endif
+	cp ./build/dist/semver.json $(OUT_DIR)/.release
+
 	@echo
 	@echo "$(LIGHTPURPLE)🎉  Add semantic-release setting files$(RESET)"
 	@echo $(OUT_DIR)/.release

README.md

@@ -1,32 +1,29 @@
-<h1 align="center">Welcome to gitmoji-semver 👋</h1>
-
-<p align="center">
-  <a href="#" target="_blank">
-    <img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-yellow.svg" />
-  </a>
-  <a href="https://gitmoji.carloscuesta.me">
-    <img src="https://img.shields.io/badge/gitmoji-%20😜%20😍-FFDD67.svg?style=flat-square" alt="Gitmoji">
-  </a>
-  <a href="https://github.com/semantic-release/semantic-release">
-    <img src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg" alt="semantic-release">
-  </a>
-</p>
-
+<h1>gitmoji-semver</h1>
+
+<a href="#" target="_blank">
+  <img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-yellow.svg" />
+</a>
+<a href="https://gitmoji.carloscuesta.me">
+  <img src="https://img.shields.io/badge/gitmoji-%20😜%20😍-FFDD67.svg?style=flat-square" alt="Gitmoji">
+</a>
+<a href="https://github.com/semantic-release/semantic-release">
+  <img src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg" alt="semantic-release">
+</a>
 
 <!-- @import "[TOC]" {cmd="toc" depthFrom=1 depthTo=6 orderedList=false} -->
 
 <!-- code_chunk_output -->
 
 - [Features](#features)
-  - [Release template type](#release-template-type)
+    - [Release template type](#release-template-type)
 - [How to use in Mac](#how-to-use-in-mac)
-  - [Install](#install)
-  - [Usage](#usage)
+    - [Install](#install)
+    - [Usage](#usage)
 - [How to auto release ( using GithubActions. only 3 minutes )](#how-to-auto-release--using-githubactions-only-3-minutes-)
-  - [Step 1: Add `.semver.yml` to your Repository root](#step-1-add-semveryml-to-your-repository-root)
-  - [Step 2: Add `release.yml` to `.github/workflows/`](#step-2-add-releaseyml-to-githubworkflows)
-  - [Step 3: Commit and Push](#step-3-commit-and-push)
-    - [If you want to run locally](#if-you-want-to-run-locally)
+    - [Step 1: Add `.semver.yml` to your Repository root](#step-1-add-semveryml-to-your-repository-root)
+    - [Step 2: Add `release.yml` to `.github/workflows/`](#step-2-add-releaseyml-to-githubworkflows)
+    - [Step 3: Commit and Push](#step-3-commit-and-push)
+        - [If you want to run locally](#if-you-want-to-run-locally)
 - [References](#references)
 - [Author](#author)
 - [Show your support](#show-your-support)
@@ -35,22 +32,20 @@
 
 ## Features
 
-- :smile: generate [gitmojis.json](https://github.com/carloscuesta/gitmoji/blob/master/src/data/gitmojis.json) with semver field.
-- :smile: generate [semantic-release](https://github.com/semantic-release/semantic-release) setting files and release template.
-- :rocket: auto release by semver (semantic versioning) just by committing with gitmoji. ( [like this](https://github.com/nkmr-jp/gitmoji-semver-sample/releases) )
+- :smile: generate [semantic-release](https://github.com/semantic-release/semantic-release) setting
+  files and release template.
+- :rocket: auto release by semver (semantic versioning) just by committing with
+  gitmoji. ( [like this](https://github.com/nkmr-jp/gitmoji-semver-sample/releases) )
 
-### Release template type
-
-| default ([example](https://github.com/nkmr-jp/gitmoji-semver-sample/releases/tag/v2.4.0)) | simple ([example](https://github.com/nkmr-jp/gitmoji-semver-sample/releases/tag/v2.3.0)) |
-| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
-| ![img.png](https://user-images.githubusercontent.com/8490118/103149917-b831ff80-47b1-11eb-85ac-d0e1328c8ad1.png)                                                         | ![img.png](https://user-images.githubusercontent.com/8490118/103149926-c2ec9480-47b1-11eb-810e-1e75ece3319f.png)                                                        |
+### Release template type ( [example](https://github.com/nkmr-jp/gitmoji-semver-sample/releases/tag/v2.3.0) )
+![img.png](https://user-images.githubusercontent.com/8490118/103149926-c2ec9480-47b1-11eb-810e-1e75ece3319f.png) 
 
 ## How to use in Mac
 
 ### Install
 
 Require `curl`, `jq`, `yq` and `node` command.
-  
+
 ```sh
 brew install curl yq jq
 
@@ -76,7 +71,8 @@ make help
 
 ## How to auto release ( using GithubActions. only 3 minutes )
 
-The following steps will auto release with gitmoji using GithubActions. You only need to add two files, and you're ready to go. Feel free to try it out in your own Github Repository.
+The following steps will auto release with gitmoji using GithubActions. You only need to add two
+files, and you're ready to go. Feel free to try it out in your own Github Repository.
 
 ### Step 1: Add `.semver.yml` to your Repository root
 
@@ -88,23 +84,17 @@ example: [./.semver.yml](.semver.yml)
 # Release Branches
 branches: [ master, main ]
 
-# gitmoji semver settings (default is none)
+# gitmoji semver settings
+# You can override the default values to suit your project.
 semver:
-  major:
-    - boom      # Introduce breaking changes.
-  minor:
-    - sparkles  # Introduce new features.
-  patch:
-    - bug                   # Fix a bug.
-    - ambulance             # Critical hotfix.
-    - green_heart           # Fix CI Build.
-    - construction_worker   # Add or update CI build system.
-  none:
-    - memo      # Add or update documentation.
-
-  # Prevents it from appearing in Github's Release.
-  ignore:
-    - construction  # Work in progress.
+  #  minor:
+  #    - lipstick
+  #  patch:
+  #    - art
+  #  none: # gitmoji.json "semver": null is convert to none
+  #    - pencil2
+  ignore: # not add in release-template.hbs
+    - construction
 ```
 
 ### Step 2: Add `release.yml` to `.github/workflows/`
@@ -140,11 +130,11 @@ jobs:
           yq --version
       - name: Install gitmoji-semver
         run: |
-          git clone https://github.com/nkmr-jp/gitmoji-semver -b v1.7.0
+          git clone https://github.com/nkmr-jp/gitmoji-semver -b v2.0.0
       - name: Generate semantic-release configs
         working-directory: ./gitmoji-semver
         run: |
-          make scaffold V=v3.0.0 F=../.semver.yml O=.. M=simple
+          make scaffold F=../.semver.yml O=..
       - name: Release
         working-directory: ./.release
         env:
@@ -182,14 +172,3 @@ act -P ubuntu-18.04=nektos/act-environments-ubuntu:18.04 # ※ 16GB docker image
 - [Semantic Versioning 2.0.0 | Semantic Versioning](https://semver.org/)
 - [Introduction to SemVer](https://blog.greenkeeper.io/introduction-to-semver-d272990c44f2)
 
-## Author
-
-👤 **nkmr-jp**
-
-## Show your support
-
-Give a ⭐️ if this project helped you!
-
-***
-_This README was generated with ❤️
-by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_

gen-release-template.js

@@ -35,19 +35,8 @@ function run() {
 }
 
 function buildTemplate(gitmojiObj) {
-    if (process.argv[2] === "simple") {
-        return `{{#if ${gitmojiObj.name.replace(/-/g, '_')}}} {{#each ${gitmojiObj.name.replace(/-/g, '_')}}}- {{> commitTemplate}}
+    return `{{#if ${gitmojiObj.name.replace(/-/g, '_')}}} {{#each ${gitmojiObj.name.replace(/-/g, '_')}}}- {{> commitTemplate}}
 {{/each}}{{/if}}`
-    } else {
-        return `
-{{#if ${gitmojiObj.name.replace(/-/g, '_')}}}
-### ${gitmojiObj.emoji} ${gitmojiObj.description} 
-{{#each ${gitmojiObj.name.replace(/-/g, '_')}}}
-- {{> commitTemplate}}
-{{/each}}
-{{/if}}
-`
-    }
 }
 
 run()