Add a workflow (.github/workflows/deploy-preview.yml
):
name: Deploy Preview
on:
pull_request:
# Optionally configure to run only for specific files. For example:
# paths:
# - "website/**"
jobs:
build_and_preview:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
# Add any build steps here. For example:
# - run: npm run build
- uses: FirebaseExtended/action-hosting-deploy@v1
with:
repoToken: "${{ secrets.GITHUB_TOKEN }}"
firebaseServiceAccount: "${{ secrets.FIREBASE_SERVICE_ACCOUNT }}"
expires: 30d
projectId: your-Firebase-project-ID
env:
FIREBASE_CLI_PREVIEWS: hostingchannels
Add a workflow (.github/workflows/deploy-prod.yml
):
name: Deploy Production Site
on:
push:
branches:
- master
# Optionally configure to run only for specific files. For example:
# paths:
# - "website/**"
jobs:
build_and_preview:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
# Add any build steps here. For example:
# - run: npm run build
- uses: FirebaseExtended/action-hosting-deploy@v1
with:
repoToken: "${{ secrets.GITHUB_TOKEN }}"
firebaseServiceAccount: "${{ secrets.FIREBASE_SERVICE_ACCOUNT }}"
expires: 30d
projectId: your-Firebase-project-ID
channelId: live
This is a service account JSON key that you can get from the
Firebase Console
(or eventually via the proposed
firebase hosting:channel:createworkflow
command).
It's important to store this token as an
encrypted secret
to prevent unintended access your Firebase project. Set it in the "Secrets" area
of your repository settings and add it as FIREBASE_SERVICE_ACCOUNT
:
https://github.com/USERNAME/REPOSITORY/settings/secrets
Adding repoToken: "${{secrets.GITHUB_TOKEN}}"
lets the action comment on PRs
with the link to the deploy preview. You don't need to set this secret
yourself - github will set it automatically.
If you omit this option, you'll need to find the preview URL in the action's build log.
The length of time the channel should live. Default is 7 days.
The project to deploy to. If you leave this blank, be sure to check in a
.firebaserc
file so the CLI knows what project to deploy to.
The channel to deploy to. If you don't set it, a new channel will be created
per-PR or per-branch. If you set it to live
, the action will deploy to your production Hosting site.
You usually want to leave this blank so that each PR gets its own channel,
unless you know you want to deploy a certain branch to a long-lived channel (for
example, you may want to deploy every commit from your next
branch to a
preprod
channel)
This GitHub Action is not an officially supported Google product