Skip to content

Latest commit

 

History

History
101 lines (71 loc) · 4.54 KB

deploying.md

File metadata and controls

101 lines (71 loc) · 4.54 KB
Raw

Deploying to profiler.firefox.com

Our hosting service is Netlify. Deploying on a nginx instance is also possible, see below.

Deploy to production

The production branch is configured to be automatically deployed to https://profiler.firefox.com.

In addition to this pushes to the main branch deploys to the domain https://main--perf-html.netlify.app. Every pull request will be deployed as well to a separate domain, whose link will be added automatically to the PR: The link to the preview deployment is in the sections where checks are

How to merge l10n into main

Our localization process happens inside Pontoon. Changes in Pontoon are being pushed into the l10n branch. They should be merged into main before the deployment.

The easiest way is to create a pull request on GitHub. It would be nice to list down the locales that are changed in the PR description. To be able to get the changed locales quickly, this command can be used (assuming that upstream is the remote you use for this repository):

git fetch upstream && git diff --name-only upstream/main...upstream/l10n | awk -F '/' '{printf $2 ", "}'; echo

Be careful to always use the create a merge commit functionality, not squash or rebase, to keep a better history.

How to deploy main to production

Before the deploy, changes in the l10n branch should be merged into main if there are any localization changes. See the section related to this step for more details.

After merging the l10n branch, we can continue with the deployment. The easiest by far is to create a pull request on GitHub. It would be nice to write down the main changes in the PR description (see below).

After the PR is created all checks should run. When it's ready the PR can be merged. Be careful to always use the create a merge commit functionality, not squash or rebase, to keep a better history. Also you can copy the PR description as the commit log body, so that the changelog is also present in the git repository.

Once it's done the new version should be deployed automatically. You can follow the process on Netlify's dashboard if you have access.

Helpful git commands to write the main changes

Here is how you can gather the changes since the last deploy:

  1. Gather all the code changes:
git fetch upstream && git log upstream/production..upstream/main --first-parent --oneline --no-decorate --format="format:[%an] %s" --reverse
  1. You'll probably need to adjust it manually: remove some useless commits (such as the dependency updates), fix some authors (as merge commits aren't always using the same author as the Pull Request author).
  2. Gather the locales author changes:
for i in ./locales/* ; do git log upstream/production..upstream/main --grep Pontoon: --oneline --no-decorate --format="format:$(basename $i): %an" $i ; done
  1. You'll also need to adjust the result, by merging the lines for the same locale.

How to revert to a previous version

The easiest way is to reset the production branch to a previous version, and force push it. You'll need to enable force-pushing for the branch production, using the Branch Settings on GitHub.

You can use the following script:

sh bin/revert-last-deployment.sh

When you're ready with a fix landed on main, you can push a new version to the production branch as described in the first part.

Mozilla internal contacts

You can find the Mozilla contacts about our deployment in this Mozilla-only document.

Deploying on a nginx instance

To deploy on nginx (without support for direct upload from the Firefox UI), run yarn build-prod and point nginx at the dist directory, which needs to be at the root of the webserver. Additionally, a error_page 404 =200 /index.html; directive needs to be added so that unknown URLs respond with index.html. For a more production-ready configuration, have a look at the netlify _headers file.