Skip to content

Latest commit

 

History

History
180 lines (123 loc) · 6.17 KB

README.md

File metadata and controls

180 lines (123 loc) · 6.17 KB
Raw

🔥🌎 Firebase Hosting GitHub Action

  • Creates a new preview channel (and its associated preview URL) for every PR on your GitHub repository.
  • Adds a comment to the PR with the preview URL so that you and each reviewer can view and test the PR's changes in a "preview" version of your app.
  • Updates the preview URL with changes from each commit by automatically deploying to the associated preview channel. The URL doesn't change with each new commit.
  • (Optional) Deploys the current state of your GitHub repo to your live channel when the PR is merged.

Setup

A full setup guide can be found in the Firebase Hosting docs.

The Firebase CLI can get you set up quickly with a default configuration.

  • If you've NOT set up Hosting, run this version of the command from the root of your local directory:
firebase init hosting
  • If you've ALREADY set up Hosting, then you just need to set up the GitHub Action part of Hosting. Run this version of the command from the root of your local directory:
firebase init hosting:github

Usage

Deploy to a new preview channel for every PR

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

name: Deploy to Preview Channel

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@v4
      # Add any build steps here. For example:
      # - run: npm ci && npm run build
      - uses: FirebaseExtended/action-hosting-deploy@v0
        with:
          repoToken: "${{ secrets.GITHUB_TOKEN }}"
          firebaseServiceAccount: "${{ secrets.FIREBASE_SERVICE_ACCOUNT }}"
          expires: 30d
          projectId: your-Firebase-project-ID

Deploy to your live channel on merge

Add a workflow (.github/workflows/deploy-prod.yml):

name: Deploy to Live Channel

on:
  push:
    branches:
      - main
    # Optionally configure to run only for specific files. For example:
    # paths:
    # - "website/**"

jobs:
  deploy_live_website:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      # Add any build steps here. For example:
      # - run: npm ci && npm run build
      - uses: FirebaseExtended/action-hosting-deploy@v0
        with:
          firebaseServiceAccount: "${{ secrets.FIREBASE_SERVICE_ACCOUNT }}"
          projectId: your-Firebase-project-ID
          channelId: live

Options

firebaseServiceAccount {string}

This is a service account JSON key. The easiest way to set it up is to run firebase init hosting:github. However, it can also be created manually.

It's important to store this token as an encrypted secret to prevent unintended access to 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.

If not provided, the action will attempt to use the default application credentials configured in your environment.

repoToken {string}

Adding repoToken: "${{secrets.GITHUB_TOKEN}}" lets the action comment on PRs with the preview URL for the associated preview channel. You don't need to set this secret yourself - GitHub sets it automatically.

If you omit this option, you'll need to find the preview URL in the action's build log.

expires {string}

The length of time the preview channel should remain active after the last deploy. If left blank, the action uses the default expiry of 7 days. The expiry date will reset to this value on every new deployment.

projectId {string}

The Firebase project that contains the Hosting site to which you want to deploy. If left blank, you need to check in a .firebaserc file so that the Firebase CLI knows which Firebase project to use.

channelId {string}

The ID of the channel to deploy to. If you leave this blank, a preview channel and its ID will be auto-generated per branch or PR. If you set it to live, the action deploys to the live channel of your default Hosting site.

You usually want to leave this blank so that each PR gets its own preview channel. An exception might be that you always want to deploy a certain branch to a long-lived preview channel (for example, you may want to deploy every commit from your next branch to a preprod preview channel).

target {string}

The target name of the Hosting site to deploy to. If you leave this blank, the default target or all targets defined in the .firebaserc will be deployed to.

You usually want to leave this blank unless you have set up multiple sites in the Firebase Hosting UI and are trying to target just one of those sites with this action.

Refer to the Hosting docs about multiple sites for more information about deploy targets.

entryPoint {string}

The directory containing your firebase.json file relative to the root of your repository. Defaults to . (the root of your repo).

firebaseToolsVersion {string}

The version of firebase-tools to use. If not specified, defaults to latest.

disableComment {boolean}

Disable commenting in a PR with the preview URL.

Outputs

Values emitted by this action that can be consumed by other actions later in your workflow

urls

The url(s) deployed to

expire_time

The time the deployed preview urls expire, example: 2024-04-10T14:37:53.817800922Z

expire_time_formatted

The time the deployed preview urls expire in the UTC format, example: Tue, 09 Apr 2024 18:24:42 GMT

details_url

A single URL that was deployed to

Status

Status: Experimental

This repository is maintained by Googlers but is not a supported Firebase product. Issues here are answered by maintainers and other community members on GitHub on a best-effort basis.