Skip to content

Commit

Permalink
Mention GitHub actions in mac/win build instructions
Browse files Browse the repository at this point in the history
This is a follow up for #730.

Now that GitHub Actions can upload installers for macOS and Windows, it's indeed a valid option for developers to build Mozc installers with their own commits.  Let's remind such a way in the build instructions.

PiperOrigin-RevId: 526715039
  • Loading branch information
yukawa authored and hiroyuki-komatsu committed Apr 24, 2023
1 parent bb50663 commit 63e12e3
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 0 deletions.
24 changes: 24 additions & 0 deletions docs/build_mozc_in_osx.md
Expand Up @@ -18,6 +18,8 @@ MOZC_QT_PATH={Your_Qt_path} bazel build package --config oss_macos -c opt
open bazel-bin/mac/Mozc.pkg
```

Hint: You can also download `Mozc.pkg` from GitHub Actions. Check [Build with GitHub Actions](#build-with-github-actions) for details.

## Get the Code

You can download Mozc source code as follows:
Expand Down Expand Up @@ -102,6 +104,28 @@ git update-index --no-assume-unchanged src/config.bzl

-----

## Build with GitHub Actions

GitHub Actions steps are already set up in [macos.yaml](../.github/workflows/macos.yaml). With that, you can build and install Mozc with your own commit as follows.

1. Fork https://github.com/google/mozc to your GitHub repository.
2. Push a new commit to your own fork.
3. Click "Actions" tab on your fork.
4. Wait until the action triggered with your commit succeeds.
5. Download `Mozc.pkg` from the action result page.
6. Install `Mozc.pkg`.

Files in the GitHub Actions page remain available up to 90 days.

You can also find Mozc Installers for macOS in google/mozc repository. Please keep in mind that Mozc is not an officially supported Google product, even if downloaded from https://github.com/google/mozc/.

1. Sign in GitHub.
2. Check [recent successfull macOS runs](https://github.com/google/mozc/actions/workflows/macos.yaml?query=is%3Asuccess) in google/mozc repository.
3. Find action in last 90 days and click it.
4. Download `Mozc.pkg` from the action result page.

-----

## Build with GYP (maintenance mode)

GYP build is under maintenance mode. Bazel build is recommended.
Expand Down
26 changes: 26 additions & 0 deletions docs/build_mozc_in_windows.md
Expand Up @@ -25,6 +25,8 @@ python build_mozc.py build -c Release package
out_win\Release\Mozc64.msi
```

Hint: You can also download `Mozc64.msi` from GitHub Actions. Check [Build with GitHub Actions](#build-with-github-actions) for details.

## Setup

### System Requirements
Expand Down Expand Up @@ -184,3 +186,27 @@ python build_mozc.py runtests -c Release
```

Note that you can specify `--qtdir=` option instead of `--noqt` in GYP phase since currently there is no unit test that depends on Qt.

---

## Build with GitHub Actions

GitHub Actions are already set up in [windows.yaml](../.github/workflows/windows.yaml). With that, you can build and install Mozc with your own commit as follows.

1. Fork https://github.com/google/mozc to your GitHub repository.
2. Push a new commit to your own fork.
3. Click "Actions" tab on your fork.
4. Wait until the action triggered with your commit succeeds.
5. Download `Mozc64.msi` from the action result page if you are using 64-bit Windows.
6. Install `Mozc64.msi`.
7. Go to "Language & region" settings, find "Japanese" to click "Language options", and click "Add a keyboard" to add "Mozc".

Files in the GitHub Actions page remain available up to 90 days.

You can also find Mozc Installers for Windows in google/mozc repository. Please keep in mind that Mozc is not an officially supported Google product, even if downloaded from https://github.com/google/mozc/.

1. Sign in GitHub.
2. Check [recent successfull Windows runs](https://github.com/google/mozc/actions/workflows/windows.yaml?query=is%3Asuccess) in google/mozc repository.
3. Find action in last 90 days and click it.
4. Download `Mozc64.msi` from the action result page if you are using 64-bit Windows.

0 comments on commit 63e12e3

Please sign in to comment.