Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add script to do the l10n extraction #9375

Merged
merged 4 commits into from
Apr 23, 2020
Merged

Add script to do the l10n extraction #9375

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3eeee98
Add script to do the l10n extraction
willdurand Apr 23, 2020
a5498fc
update docs
willdurand Apr 23, 2020
d7f3691
fix git remote
willdurand Apr 23, 2020
6aa5dee
detect local changes
willdurand Apr 23, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
91 changes: 91 additions & 0 deletions bin/run-l10n-extraction
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
#!/usr/bin/env bash

# Exit immediately when a command fails.
set -e
# Make sure exit code are respected in a pipeline.
set -o pipefail
# Treat unset variables as an error an exit immediately.
set -u

INITIAL_GIT_BRANCH=$(git rev-parse --abbrev-ref HEAD)
GIT_CHANGES=$(git status --porcelain)
DIFF_WITH_ONE_LINE_CHANGE="1 file changed, 1 insertion(+), 1 deletion(-)"
GIT_REMOTE="[email protected]:mozilla/addons-frontend.git"

info() {
local message="$1"

echo ""
echo "INFO: $message"
echo ""
}

error() {
local message="$1"

echo "ERROR: $message"
exit 1
}

run_l10n_extraction() {
local app="$1"
local branch="$app-locales"

# Detect local (uncommitted) changes.
if [[ ! -z "$GIT_CHANGES" ]]; then
error "You have local changes, therefore this script cannot continue."
fi

# Switch to the `master` branch if we are not on it already.
if [[ "$INITIAL_GIT_BRANCH" != "master" ]]; then
willdurand marked this conversation as resolved.
Show resolved Hide resolved
git checkout master
fi

# Make sure the 'master' branch is up-to-date.
git pull "$GIT_REMOTE" master

# Ensure the branch to extract the locales is clean.
if [[ $(git branch --list "$branch") ]]; then
info "Deleting branch '$branch' because it already exists"
git branch -D "$branch"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we delete the remote branch too?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, because we need it to open the pull request. That being said, we might want to force push the remote branches in case we didn't delete it previously (github should automatically delete a git branch when the corresponding PR is merged).

fi

info "Creating and switching to branch '$branch'"
git checkout -b "$branch"

NODE_APP_INSTANCE="$app" bin/extract-locales

local git_diff_stat
git_diff_stat=$(git diff --shortstat)

if [[ -z "$git_diff_stat" ]] || [[ "$git_diff_stat" == *"$DIFF_WITH_ONE_LINE_CHANGE"* ]]; then
info "No changes, aborting"
git checkout -- .
git checkout "$INITIAL_GIT_BRANCH"
git branch -d "$branch"
exit 0
fi

git commit -a -m "Extract $app locales"

NODE_APP_INSTANCE="$app" bin/merge-locales

git commit -a -m "Merge $app locales"

# We use force-push in case the branch already exists.
git push -f "$GIT_REMOTE" "$branch"

git checkout "$INITIAL_GIT_BRANCH"
git branch -D "$branch"

echo ""
echo "----------------------------------------------------------------------"
echo ""
echo " You can now open the link below to submit your Pull Request:"
echo " https://github.com/mozilla/addons-frontend/pull/new/$branch"
echo ""
echo "----------------------------------------------------------------------"
}

run_l10n_extraction "amo"
run_l10n_extraction "disco"
12 changes: 8 additions & 4 deletions docs/i18n.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@ NODE_APP_INSTANCE=[MY_APP] NODE_PATH='./:./src' bin/create-locales

## Updating locales

TL;DR: run the following script from the `master` branch: `./bin/run-l10n-extraction`

### The long story

Once a week right after the forthcoming release [is tagged](http://addons.readthedocs.io/en/latest/server/push-duty.html), the locales for each app must be generated.

This is a semi-automated process: a team member must create one pull request _per application_ with the following commits:
Expand All @@ -31,7 +35,7 @@ This is a semi-automated process: a team member must create one pull request _pe

Each one of these steps are detailed in the sections below. Let's begin...

### Extracting newly added strings
#### Extracting newly added strings

Start the process by creating a git branch and extracting the locales for a given app. This uses `amo` as an example app but you would need to repeat the process in a new branch for `disco` and any other activate application (example: `NODE_APP_INSTANCE=disco ...`).

Expand Down Expand Up @@ -70,7 +74,7 @@ When the application is under active development it's more likely that you will
git commit -a -m "Extract AMO locales"
```

### Merging locale files
#### Merging locale files

After extracting new strings, you have to merge them into the existing locale files. Do this in your branch and commit:

Expand All @@ -88,7 +92,7 @@ Commit and continue to the next step:
git commit -a -m "Merged AMO locales"
```

### Finalizing the extract/merge process
#### Finalizing the extract/merge process

Now that you have extracted and merged locales for one application, it's time to create a pull request for your branch. For example:

Expand All @@ -98,7 +102,7 @@ git push origin amo-locales

If the pull request passes all of our CI tests it is likely good to merge. You don't need to ask for a review unless you're unsure of something because often locale updates will be thousands of lines of minor diffs that can't be reasonably reviewed by a human. 🙂 If the pull request passes all of our CI tests it is likely good to merge. If necessary, repeat the process for the next application (eg. `amo`, `disco`, etc.).

### Building the JS locale files
#### Building the JS locale files

This command creates the JSON files which are then built into JS bundles by webpack when the build step is run. This happens automatically as part of the deployment process.

Expand Down