Skip to content

Commit 74b139e

Browse files
committed
📝 Update README.md
1 parent dcf9a7f commit 74b139e

File tree

1 file changed

+39
-15
lines changed

1 file changed

+39
-15
lines changed

README.md

Lines changed: 39 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -13,19 +13,40 @@
1313
</p>
1414

1515

16-
> You can do easily Semver Release automatically by just committing with gitmoji. ( [like this](https://github.com/nkmr-jp/gitmoji-semver/releases) )
17-
18-
- A simple script to add the semver field to [gitmojis.json](https://github.com/carloscuesta/gitmoji/blob/master/src/data/gitmojis.json).
16+
<!-- @import "[TOC]" {cmd="toc" depthFrom=1 depthTo=6 orderedList=false} -->
17+
18+
<!-- code_chunk_output -->
19+
20+
- [Features](#features)
21+
- [How to use in GithubActions ( only 3 minutes )](#how-to-use-in-githubactions--only-3-minutes-)
22+
- [Step 1: Add `.semver.yml` to your Repository root](#step-1-add-semveryml-to-your-repository-root)
23+
- [Step 2: Add `release.yml` to `.github/workflows/`](#step-2-add-releaseyml-to-githubworkflows)
24+
- [Step 3: Commit and Push](#step-3-commit-and-push)
25+
- [If you want to run locally](#if-you-want-to-run-locally)
26+
- [How to use in Mac](#how-to-use-in-mac)
27+
- [Install](#install)
28+
- [Usage](#usage)
29+
- [Reference](#reference)
30+
- [Author](#author)
31+
- [Show your support](#show-your-support)
32+
33+
<!-- /code_chunk_output -->
34+
35+
36+
## Features
37+
- :smile: A simple script to add the semver field to [gitmojis.json](https://github.com/carloscuesta/gitmoji/blob/master/src/data/gitmojis.json).
1938
- Generate the files `gitmojis.json` with the semver field added.
2039
- I referred to this issue. ( [Add a "semver" field for each emoji #429](https://github.com/carloscuesta/gitmoji/issues/429) )
21-
- Automate versioning and release with GithubActions and [semantic-release](https://github.com/semantic-release/semantic-release).
40+
- :rocket: You can easily do Semver Release automatically by just committing with gitmoji. ( [like this](https://github.com/nkmr-jp/gitmoji-semver/releases) )
41+
- Automate versioning and release with GithubActions and [semantic-release](https://github.com/semantic-release/semantic-release).
42+
2243

23-
## Run in Github Actions
44+
## How to use in GithubActions ( only 3 minutes )
2445

2546
The following steps will automate versioning and releasing with gitmoji using GithubActions.
26-
You only need to add two files, and you're ready to go. Feel free to try it out in your own Github repository. (**Estimated time: 3 minutes**)
47+
You only need to add two files, and you're ready to go. Feel free to try it out in your own Github Repository.
2748

28-
### Step 1: Create `.semver.yml` to your Repository root
49+
### Step 1: Add `.semver.yml` to your Repository root
2950

3051
example: [./.semver.yml](.semver.yml)
3152

@@ -42,9 +63,10 @@ semver:
4263
minor:
4364
- sparkles # Introduce new features.
4465
patch:
45-
- bug # Fix a bug.
46-
- ambulance # Critical hotfix.
47-
- green_heart # Fix CI Build.
66+
- bug # Fix a bug.
67+
- ambulance # Critical hotfix.
68+
- green_heart # Fix CI Build.
69+
- construction_worker # Add or update CI build system.
4870
none:
4971
- memo # Add or update documentation.
5072

@@ -53,7 +75,7 @@ semver:
5375
- construction # Work in progress.
5476
```
5577
56-
### Step 2: Create `release.yml` to `.github/workflows/`
78+
### Step 2: Add `release.yml` to `.github/workflows/`
5779

5880
```yml
5981
# .github/workflows/release.yml
@@ -107,18 +129,20 @@ git commit -m ":construction_worker: Add Release settings by https://github.com/
107129
git push
108130
```
109131

110-
Check out the release in your Github Repository.
132+
:tada: Done! Check out the Release Page in your Github Repository.
111133

112-
### If you want to run locally
134+
#### If you want to run locally
113135

114-
There will not be an actual Release.You can see how it works.
136+
There will not be an actual Release. You can see how it works.
115137

116138
```sh
117139
brew install act
118140
act -P ubuntu-18.04=nektos/act-environments-ubuntu:18.04 # ※ 16GB docker image
119141
```
120142

121-
## Run in Mac
143+
## How to use in Mac
144+
145+
You can use various commands. It makes it easy to customize settings.
122146

123147
### Install
124148
require `curl`, `jq`, `yq` and `node` command.

0 commit comments

Comments
 (0)