Skip to content

Latest commit

 

History

History
164 lines (128 loc) · 4.76 KB

README_JA.md

File metadata and controls

164 lines (128 loc) · 4.76 KB

English | 日本語

😄 gitmoji-semver 🚀

License: MIT Gitmoji semantic-release

😆 gitmojiでコミットするだけで、セマンティックバージョニングによるオートバージョニングとgithubへのオートリリースが可能になります。

自動バージョニングとgithubへのリリース (example)
image

自動リリースの方法

GithubActionsを使います。所要時間3分

ファイルを2つ追加するだけで準備は完了です。自分のGithubリポジトリで気軽に試してみてください。

手順 1: .semver.yml をリポジトリのルートに追加

example: ./.semver.yml

# .semver.yml

# Release Branches
branches: [ master, main ]

# gitmoji semver settings
# You can override the default values to suit your project.
semver:
  #  minor:
  #    - lipstick
  #  patch:
  #    - art
  #  none: # gitmoji.json "semver": null is convert to none
  #    - pencil2
  ignore: # not add in release-template.hbs
    - construction

手順 2: release.yml.github/workflows/ に追加

# .github/workflows/release.yml

name: Release
on:
  push:
    branches:
      - master
      - main
jobs:
  release:
    name: Release
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v2
        with:
          fetch-depth: 0
      - name: Setup Node.js
        uses: actions/setup-node@v1
        with:
          node-version: 12
      - name: Install jq yq
        run: |
          sudo wget https://github.com/stedolan/jq/releases/download/jq-1.6/jq-linux64 -O /usr/bin/jq &&\
          sudo chmod +x /usr/bin/jq
          sudo pip install yq
          jq --version
          yq --version
      - name: Install gitmoji-semver
        run: |
          git clone https://github.com/nkmr-jp/gitmoji-semver -b v2.0.4
      - name: Generate semantic-release configs
        working-directory: ./gitmoji-semver
        run: |
          make scaffold F=../.semver.yml O=..
      - name: Release
        working-directory: ./.release
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        run: |
          npm install
          npx semantic-release

手順 3: コミットしてプッシュ

git add .
git commit -m ":sparkles: Introduce new features."
git push

🎉 終了です。Githubリポジトリのリリースページを確認してみましょう。

Macでの使用方法 (オプション)

インストール

curl, jq, yqnode コマンドが必要です。

brew install curl yq jq

yq --version
# yq 2.10.1
jq --version
# jq-1.6
node --version
# v13.14.0 # Probably works in other versions too.

# Install
git clone https://github.com/nkmr-jp/gitmoji-semver

使い方

cd ./gitmoji-semver
make help

参照