Skip to content

Commit 945dbe4

Browse files
committed
Change ZEIT to Vercel
1 parent 2997ce9 commit 945dbe4

2 files changed

Lines changed: 14 additions & 16 deletions

File tree

README.md

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
1-
![](https://raw.githubusercontent.com/zeit/art/e0348ab1848337de87ccbb713fa33345aa0ba153/release/repo-banner.png)
2-
1+
![](https://raw.githubusercontent.com/vercel/art/e0348ab1848337de87ccbb713fa33345aa0ba153/release/repo-banner.png)
32

43
<a aria-label="Vercel logo" href="https://vercel.com">
5-
<img src="https://img.shields.io/badge/MADE%20BY%20Vercel-000000.svg?style=for-the-badge&logo=ZEIT&labelColor=000000&logoWidth=20">
4+
<img src="https://img.shields.io/badge/MADE%20BY%20Vercel-000000.svg?style=for-the-badge&logo=vercel&labelColor=000000&logoWidth=20">
65
</a>
76

8-
9-
[![Build Status](https://circleci.com/gh/zeit/release.svg?&style=shield)](https://circleci.com/gh/zeit/release)
10-
[![Join the community on Spectrum](https://withspectrum.github.io/badge/badge.svg)](https://spectrum.chat/zeit)
7+
[![Build Status](https://circleci.com/gh/vercel/release.svg?&style=shield)](https://circleci.com/gh/vercel/release)
8+
[![Join the community on GitHub Discussions](https://img.shields.io/badge/Join%20the%20community-blueviolet.svg?style=for-the-badge&logo=vercel&labelColor=000000&logoWidth=20)](https://github.com/vercel/vercel/discussions)
119

1210
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.
1311

@@ -35,9 +33,9 @@ As you can see, a `<type>` argument can be passed. If you leave it out, a [GitHu
3533

3634
According to the [SemVer](https://semver.org) spec, the argument can have one of these values:
3735

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
4139

4240
In addition to those values, we also support creating pre-releases like `3.0.0-canary.1`:
4341

@@ -83,15 +81,15 @@ By default, release will look for a file named `release.js` in the root director
8381

8482
```js
8583
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+
};
8987
```
9088

9189
In the example above, `markdown` contains the release as a `String` (if you just want to replace something). In addition, `metaData` contains these properties:
9290

9391
| Property Name | Content |
94-
|------------------|-------------------------------------------------------|
92+
| ---------------- | ----------------------------------------------------- |
9593
| `changeTypes` | The types of changes and their descriptions |
9694
| `commits` | A list of commits since the latest release |
9795
| `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
10199

102100
## Why?
103101

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.
105103

106104
## Contributing
107105

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).
109107

110108
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
111109
2. Uninstall the package if it's already installed: `npm uninstall -g release`

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
"bin",
1212
"lib"
1313
],
14-
"repository": "zeit/release",
14+
"repository": "vercel/release",
1515
"keywords": [
1616
"github",
1717
"releases",

0 commit comments

Comments
 (0)