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
[](https://github.com/vercel/vercel/discussions)
11
9
12
10
When run, this command line interface automatically generates a new [GitHub Release](https://help.github.com/articles/creating-releases/) and populates it with the changes (commits) made since the last release.
13
11
@@ -35,9 +33,9 @@ As you can see, a `<type>` argument can be passed. If you leave it out, a [GitHu
35
33
36
34
According to the [SemVer](https://semver.org) spec, the argument can have one of these values:
37
35
38
-
-`major`: Incompatible API changes were introduced
39
-
-`minor`: Functionality was added in a backwards-compatible manner
40
-
-`patch`: Backwards-compatible bug fixes were applied
36
+
-`major`: Incompatible API changes were introduced
37
+
-`minor`: Functionality was added in a backwards-compatible manner
38
+
-`patch`: Backwards-compatible bug fixes were applied
41
39
42
40
In addition to those values, we also support creating pre-releases like `3.0.0-canary.1`:
43
41
@@ -83,15 +81,15 @@ By default, release will look for a file named `release.js` in the root director
83
81
84
82
```js
85
83
module.exports=async (markdown, metaData) => {
86
-
// Use the available data to create a custom release
87
-
return markdown
88
-
}
84
+
// Use the available data to create a custom release
85
+
return markdown;
86
+
};
89
87
```
90
88
91
89
In the example above, `markdown` contains the release as a `String` (if you just want to replace something). In addition, `metaData` contains these properties:
|`changeTypes`| The types of changes and their descriptions |
96
94
|`commits`| A list of commits since the latest release |
97
95
|`groupedCommits`| Similar to `commits`, but grouped by the change types |
@@ -101,11 +99,11 @@ In the example above, `markdown` contains the release as a `String` (if you just
101
99
102
100
## Why?
103
101
104
-
As we at [ZEIT](https://github.com/zeit) moved all of our GitHub repositories from keeping a `HISTORY.md` file to using [GitHub Releases](https://help.github.com/articles/creating-releases/), we needed a way to automatically generate these releases from our own devices, rather than always having to open a page in the browser and manually add the notes for each change.
102
+
As we at [Vercel](https://github.com/vercel) moved all of our GitHub repositories from keeping a `HISTORY.md` file to using [GitHub Releases](https://help.github.com/articles/creating-releases/), we needed a way to automatically generate these releases from our own devices, rather than always having to open a page in the browser and manually add the notes for each change.
105
103
106
104
## Contributing
107
105
108
-
You can find the authentication flow [here](https://github.com/zeit/release-auth).
106
+
You can find the authentication flow [here](https://github.com/vercel/release-auth).
109
107
110
108
1.[Fork](https://help.github.com/articles/fork-a-repo/) this repository to your own GitHub account and then [clone](https://help.github.com/articles/cloning-a-repository/) it to your local device
111
109
2. Uninstall the package if it's already installed: `npm uninstall -g release`
0 commit comments