Skip to content

Commit 63024f2

Browse files
nkmr-jpnkmr-jp
committed
📝 Add README_JA.md
1 parent 781fb61 commit 63024f2

File tree

2 files changed

+174
-3
lines changed

2 files changed

+174
-3
lines changed

‎README.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
[English](README.md) | [日本語](README_JA.md)
2+
13
<h1 align="center">😄 gitmoji-semver 🚀</h1>
24

35
<p align="center">
@@ -45,8 +47,7 @@
4547

4648
## How to auto release ( using GithubActions. only 3 minutes )
4749

48-
The following steps will auto release with gitmoji using GithubActions. You only need to add two
49-
files, and you're ready to go. Feel free to try it out in your own Github Repository.
50+
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.
5051

5152
### Step 1: Add `.semver.yml` to your Repository root
5253

@@ -128,7 +129,7 @@ git push
128129

129130
:tada: Done! Check out the Release Page in your Github Repository.
130131

131-
## How to use in Mac
132+
## How to use in Mac (option)
132133

133134
### Install
134135

‎README_JA.md‎

Lines changed: 170 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,170 @@
1+
[English](README.md) | [日本語](README_JA.md)
2+
3+
<h1 align="center">😄 gitmoji-semver 🚀</h1>
4+
5+
<p align="center">
6+
<a href="#" target="_blank">
7+
<img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-yellow.svg" />
8+
</a>
9+
<a href="https://gitmoji.carloscuesta.me">
10+
<img src="https://img.shields.io/badge/gitmoji-%20😜%20😍-FFDD67.svg?style=flat-square" alt="Gitmoji">
11+
</a>
12+
<a href="https://github.com/semantic-release/semantic-release">
13+
<img src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg" alt="semantic-release">
14+
</a>
15+
</p>
16+
17+
<p align="center">
18+
😆 gitmojiでコミットするだけで、セマンティックバージョニングによるオートバージョニングとgithubへのオートリリースが可能になります。
19+
</p>
20+
21+
22+
23+
| 自動バージョニングとgithubへのリリース ([example](https://github.com/nkmr-jp/gitmoji-semver-sample/releases/tag/v4.0.0)) |
24+
|--|
25+
| ![image](https://user-images.githubusercontent.com/8490118/107201108-e60a9500-6a3b-11eb-875b-76b0efe2622e.png) |
26+
27+
28+
<!-- @import "[TOC]" {cmd="toc" depthFrom=1 depthTo=6 orderedList=false} -->
29+
30+
<!-- code_chunk_output -->
31+
32+
- [特徴](#特徴)
33+
- [自動リリースの方法 (GithubActionsを使います。所要時間3分)](#自動リリースの方法-githubactionsを使います所要時間3分)
34+
- [手順 1: `.semver.yml` をリポジトリのルートに追加](#手順-1-semveryml-をリポジトリのルートに追加)
35+
- [手順 2: `release.yml` を `.github/workflows/` に追加](#手順-2-releaseyml-を-githubworkflows-に追加)
36+
- [手順 3: コミットしてプッシュ](#手順-3-コミットしてプッシュ)
37+
- [Macでの使用方法 (オプション)](#macでの使用方法-オプション)
38+
- [インストール](#インストール)
39+
- [使い方](#使い方)
40+
- [参照](#参照)
41+
42+
<!-- /code_chunk_output -->
43+
44+
## 特徴
45+
46+
- :smile: [semantic-release](https://github.com/semantic-release/semantic-release) の設定ファイルやテンプレート生成。
47+
- :rocket: gitmojiを使ったコミットをするだけで semver (semantic versioning) による自動バージョニングとリリース. ( [like this](https://github.com/nkmr-jp/gitmoji-semver-sample/releases) )
48+
49+
## 自動リリースの方法 (GithubActionsを使います。所要時間3分)
50+
51+
以下の手順でGithubActionsを使ってgitmojiで自動リリースします。
52+
ファイルを2つ追加するだけで、準備は完了です。
53+
自分のGithubリポジトリで気軽に試してみてください。
54+
55+
### 手順 1: `.semver.yml` をリポジトリのルートに追加
56+
57+
example: [./.semver.yml](.semver.yml)
58+
59+
```yml
60+
# .semver.yml
61+
62+
# Release Branches
63+
branches: [ master, main ]
64+
65+
# gitmoji semver settings
66+
# You can override the default values to suit your project.
67+
semver:
68+
# minor:
69+
# - lipstick
70+
# patch:
71+
# - art
72+
# none: # gitmoji.json "semver": null is convert to none
73+
# - pencil2
74+
ignore: # not add in release-template.hbs
75+
- construction
76+
```
77+
78+
### 手順 2: `release.yml` を `.github/workflows/` に追加
79+
80+
```yml
81+
# .github/workflows/release.yml
82+
83+
name: Release
84+
on:
85+
push:
86+
branches:
87+
- master
88+
- main
89+
jobs:
90+
release:
91+
name: Release
92+
runs-on: ubuntu-18.04
93+
steps:
94+
- name: Checkout
95+
uses: actions/checkout@v2
96+
with:
97+
fetch-depth: 0
98+
- name: Setup Node.js
99+
uses: actions/setup-node@v1
100+
with:
101+
node-version: 12
102+
- name: Install jq yq
103+
run: |
104+
sudo wget https://github.com/stedolan/jq/releases/download/jq-1.6/jq-linux64 -O /usr/bin/jq &&\
105+
sudo chmod +x /usr/bin/jq
106+
sudo pip install yq
107+
jq --version
108+
yq --version
109+
- name: Install gitmoji-semver
110+
run: |
111+
git clone https://github.com/nkmr-jp/gitmoji-semver -b v2.0.0
112+
- name: Generate semantic-release configs
113+
working-directory: ./gitmoji-semver
114+
run: |
115+
make scaffold F=../.semver.yml O=..
116+
- name: Release
117+
working-directory: ./.release
118+
env:
119+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
120+
run: |
121+
npm install
122+
npx semantic-release
123+
```
124+
125+
### 手順 3: コミットしてプッシュ
126+
127+
```sh
128+
git add .
129+
git commit -m ":sparkles: Introduce new features."
130+
git push
131+
```
132+
133+
:tada: 完了しました。Githubリポジトリのリリースページを確認してみましょう。
134+
135+
## Macでの使用方法 (オプション)
136+
137+
### インストール
138+
139+
`curl`, `jq`, `yq` と `node` コマンドが必要です。
140+
141+
```sh
142+
brew install curl yq jq
143+
144+
yq --version
145+
# yq 2.10.1
146+
jq --version
147+
# jq-1.6
148+
node --version
149+
# v13.14.0 # Probably works in other versions too.
150+
151+
# Install
152+
git clone https://github.com/nkmr-jp/gitmoji-semver
153+
```
154+
155+
### 使い方
156+
157+
```sh
158+
cd ./gitmoji-semver
159+
make help
160+
```
161+
162+
## 参照
163+
164+
- [Add a "semver" field for each emoji #429](https://github.com/carloscuesta/gitmoji/issues/429)
165+
- [gitmoji | An emoji guide for your commit messages](https://gitmoji.carloscuesta.me/)
166+
- [GitHub - semantic-release/semantic-release](https://github.com/semantic-release/semantic-release)
167+
- [GitHub - momocow/semantic-release-gitmoji](https://github.com/momocow/semantic-release-gitmoji)
168+
- [Semantic Versioning 2.0.0 | Semantic Versioning](https://semver.org/)
169+
- [Introduction to SemVer](https://blog.greenkeeper.io/introduction-to-semver-d272990c44f2)
170+

0 commit comments

Comments
 (0)