Deploying to Firebase

This page explains how to deploy applications to Firebase using Cloud Build. If you're new to Cloud Build, read the quickstarts and the Build configuration overview first.

Before you begin

  • Enable the Cloud Build, Firebase, and Resource Manager APIs.

    Enable the APIs

  • To run the gcloud commands on this page, install the Google Cloud CLI.

  • Keep your application source code including firebase.json handy. Your source code needs to be stored in a repository, such as Cloud Source Repositories, GitHub, or Bitbucket.

  • If you don't already have a project to deploy to Firebase, you can create a default project by installing and initializing Firebase.

Required IAM permissions

  1. Open the IAM page in the Google Cloud console:

    Open the IAM page

  2. Select your project and click Open.

  3. In the permissions table, locate the email for the service account you are using for the build and click the pencil icon.

  4. Add the Cloud Build Service Account(roles/cloudbuild.builds.builder), Firebase Admin (roles/firebase.admin), andAPI Keys Admin (roles/serviceusage.apiKeysAdmin) roles to the service account.

  5. Click Save.

Using the firebase Docker image

Cloud Build provides a builder image that you can use to invoke firebase commands in Cloud Build. To use this builder in a Cloud Build config file, you can use the firebase build step to deploy to Firebase:

  1. Create a build config file named cloudbuild.yaml or cloudbuild.json where PROJECT_ID is your Google Cloud project ID and FIREBASE_PROJECT_ID is your Firebase project ID:

    YAML 

    steps:
- name: "us-docker.pkg.dev/firebase-cli/us/firebase"
   args: ['deploy', '--project=FIREBASE_PROJECT_ID', '--only=hosting']
## Or, target a specific version of firebase-tools
- name: "us-docker.pkg.dev/firebase-cli/us/firebase":x.y.z
   args: ['deploy', '--project=FIREBASE_PROJECT_ID', '--only=hosting']

    JSON 

    {
  "steps": [
   {
      "name": "us-docker.pkg.dev/firebase-cli/us/firebase",
      "args": [
         "deploy",
         "--project",
         "FIREBASE_PROJECT_ID",
         "--only",
         "hosting"
       ]
  }
  ]
}

    You can choose a specific version of firebase-tools by using
    name: "us-docker.pkg.dev/firebase-cli/us/firebase":x.y.z

  2. Start the build using the build config file:

    gcloud builds submit --region=REGION --config CONFIG_FILE_PATH SOURCE_DIRECTORY

    Where:

    • REGION is one of the supported build regions.
    • CONFIG_FILE_PATH is the path to the build config file.
    • SOURCE_DIRECTORY is the path or URL to the source code.

Continuous deployment

You can automate the deployment of your software to Firebase by creating Cloud Build triggers. You can configure triggers to build and deploy images whenever you update your source code.

To automate your deployment to Firebase:

  1. In your repository, add a build config file with steps to invoke the firebase deploy command where PROJECT_ID is your Google Cloud project ID:

    YAML

    steps:
      - name: us-docker.pkg.dev/firebase-cli/us/firebase
        args: ['deploy', '--project=PROJECT_ID', '--only=hosting']

    JSON 

    {
  "steps": [
   {
      "name": "us-docker.pkg.dev/firebase-cli/us/firebase",
      "args": [
         "deploy",
         "--project",
         "PROJECT_ID",
         "--only",
         "hosting"
       ]
  }
  ]
}

  2. Create a trigger with the build config file created in the previous step:

    1. Open the Triggers page in the Google Cloud console:

      Open Triggers page

    2. Select your project from the project selector drop-down menu at the top of the page.

    3. Click Open.

    4. Click Create trigger.

      On the Create trigger page, enter the following settings:

      1. Enter a name for your trigger.

      2. Select the repository event to start your trigger.

      3. Select the repository that contains your source code and build config file.

      4. Specify the regex for the branch or tag name that will start your trigger.

      5. Configuration: Choose the build config file you created previously.

    5. Click Create to save your build trigger.

Anytime you push new code to your repository, you will automatically start a build and deploy on Firebase.

For more information on creating Cloud Build triggers, see Creating and managing build triggers.

Code example

To view a code sample for deploying to Firebase using Cloud Build, go to deploy-firebase-example.

What's next