You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
2. Register `TUI_GITHUB_TOKEN` as an environment variable or `token` property in `tui-note.config.js`.
63
+
2. Register Github access token by `TUI_GITHUB_TOKEN` as an environment variable or `token` property in `tui-note.config.js`. To generate a token, please refer to [this](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line).
# if you do not set a tag in a config file, latest tag
66
85
npm run note
86
+
67
87
# specific tag
88
+
# it will overwrite a tag in a config file
68
89
npm run note -- --tag={specific-tag}
69
-
# enterprise
70
-
npm run note -- --apiUrl={github.your-enterprise-url.com/api/v3}
71
90
```
72
91
73
92
### Add a config file
@@ -76,13 +95,13 @@ Add your config files to the root of your working directory. The config file mus
76
95
77
96
| Option | Type | Description |
78
97
| --- | --- | --- |
79
-
|`token`|`string`| Github access token for tui-release-note. If you pass a token as an environment variable, it will be overwritten. |
98
+
|`token`|`string`| Github access token for toast-ui.release-notes. If you pass a token as an environment variable, it will be overwritten. |
80
99
|`tag`|`string`| Tag to create a release note. If you pass a tag as the command line argument, it will be overwritten. (default: the latest tag) |
81
-
|`apiUrl`|`string`| Github API url. If you use the enterprise github, set your enterprise github url. (default: https://api.github.com)|
82
-
|`groupBy`|`object`| Determine how to categorize commits by their types. 'key' is `group name` and 'value' is `array of types`. (default: [defaultConfig.groupBy](https://github.com/nhn/tui.release-notes/blob/master/src/defaultConfig.js#L9)) |
83
-
|`commitMessage.type`|`function`| Determine how to get a type from a commit message. (default: [defaultConfig.commitMessage.type](https://github.com/nhn/tui.release-notes/blob/master/src/defaultConfig.js#L21)) |
84
-
|`template.commit`|`function`| Note from a commit. (default: [defaultConfig.template.commit](https://github.com/nhn/tui.release-notes/blob/master/src/defaultConfig.js#L33)) |
85
-
|`downloads`|`function \| object`| Links to download the files. (reference: [defaultConfig.downloads](https://github.com/nhn/tui.release-notes/blob/master/src/defaultConfig.js#L47)) |
100
+
|`apiUrl`|`string`| Github API url. If you use the enterprise github, set your enterprise github url (ex. github.your-enterprise-url.com/api/v3). (default: https://api.github.com)|
101
+
|`groupBy`|`object`| Determine how to categorize commits by their types. 'key' is `group name` and 'value' is `array of types`. (default: [defaultConfig.groupBy](https://github.com/nhn/toast-ui.release-notes/blob/master/src/defaultConfig.js#L9)) |
102
+
|`commitMessage.type`|`function`| Determine how to get a type from a commit message. (default: [defaultConfig.commitMessage.type](https://github.com/nhn/toast-ui.release-notes/blob/master/src/defaultConfig.js#L21)) |
103
+
|`template.commit`|`function`| Note from a commit. (default: [defaultConfig.template.commit](https://github.com/nhn/toast-ui.release-notes/blob/master/src/defaultConfig.js#L33)) |
104
+
|`downloads`|`function \| object`| Links to download the files. (reference: [defaultConfig.downloads](https://github.com/nhn/toast-ui.release-notes/blob/master/src/defaultConfig.js#L47)) |
86
105
87
106
88
107
## 🔧 Pull Request Steps
@@ -97,8 +116,8 @@ Clone it to local computer. Install node modules.
97
116
Before starting development, you should check to haveany errors.
0 commit comments