Skip to content

Commit 6f364f2

Browse files
copy-edits for README (#30)
1 parent 9314d5f commit 6f364f2

File tree

1 file changed

+22
-18
lines changed

1 file changed

+22
-18
lines changed

README.md

Lines changed: 22 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22

33
## Usage
44

5-
### Deploy a to a new preview channel for every PR
5+
### Deploy to a new preview channel for every PR
66

77
Add a workflow (`.github/workflows/deploy-preview.yml`):
88

99
```yaml
10-
name: Deploy Preview
10+
name: Deploy to Preview Channel
1111

1212
on:
1313
pull_request:
@@ -32,12 +32,12 @@ jobs:
3232
FIREBASE_CLI_PREVIEWS: hostingchannels
3333
```
3434
35-
### Deploy to your live site on merge
35+
### Deploy to your live channel on merge
3636
3737
Add a workflow (`.github/workflows/deploy-prod.yml`):
3838

3939
```yaml
40-
name: Deploy Production Site
40+
name: Deploy to Live Channel
4141
4242
on:
4343
push:
@@ -71,41 +71,45 @@ This is a service account JSON key.
7171

7272
It's important to store this token as an
7373
[encrypted secret](https://help.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets)
74-
to prevent unintended access your Firebase project. Set it in the "Secrets" area
74+
to prevent unintended access to your Firebase project. Set it in the "Secrets" area
7575
of your repository settings and add it as `FIREBASE_SERVICE_ACCOUNT`:
76-
`https://github.com/USERNAME/REPOSITORY/settings/secrets`
76+
`https://github.com/USERNAME/REPOSITORY/settings/secrets`.
7777

7878
### `repoToken` _{string}_
7979

8080
Adding `repoToken: "${{secrets.GITHUB_TOKEN}}"` lets the action comment on PRs
81-
with the link to the deploy preview. You don't need to set this secret
82-
yourself - github will set it automatically.
81+
with the preview URL for the associated preview channel. You don't need to set
82+
this secret yourself - GitHub sets it automatically.
8383
8484
If you omit this option, you'll need to find the preview URL in the action's
8585
build log.
8686
8787
### `expires` _{string}_
8888

89-
The length of time the channel should live. If left blank, uses the Firebase Hosting default expiry (7 days).
89+
The length of time the preview channel should remain active.
90+
If left blank, the action uses the default expiry of 7 days.
9091

9192
### `projectId` _{string}_
9293

93-
The project to deploy to. If you leave this blank, be sure to check in a
94-
`.firebaserc` file so the CLI knows what project to deploy to.
94+
The Firebase project that contains the Hosting site to which you
95+
want to deploy. If left blank, you need to check in a `.firebaserc`
96+
file so that the Firebase CLI knows which Firebase project to use.
9597

9698
### `channelId` _{string}_
9799

98-
The channel to deploy to. If you don't set it, a new channel will be created
99-
per-PR or per-branch. If you set it to **`live`**, the action will deploy to your production Hosting site.
100+
The channel to deploy to. If you don't set it, the action creates
101+
a new preview channel per-PR or per-branch. If you set it to **`live`**,
102+
the action deploys to the live channel of your default Hosting site.
100103

101-
You usually want to leave this blank so that each PR gets its own channel,
102-
unless you know you want to deploy a certain branch to a long-lived channel (for
103-
example, you may want to deploy every commit from your `next` branch to a
104-
`preprod` channel)
104+
You usually want to leave this blank so that each PR gets its own preview channel.
105+
An exception might be that you always want to deploy a certain branch to a
106+
long-lived preview channel (for example, you may want to deploy every commit
107+
from your `next` branch to a `preprod` preview channel).
105108

106109
### `entryPoint` _{string}_
107110

108-
The location of your [`firebase.json`](https://firebase.google.com/docs/cli#the_firebasejson_file) file relative to the root of your repository. Defaults to `.` (the root of your repo).
111+
The location of your [`firebase.json`](https://firebase.google.com/docs/cli#the_firebasejson_file)
112+
file relative to the root of your repository. Defaults to `.` (the root of your repo).
109113

110114
---
111115

0 commit comments

Comments
 (0)