2015-03-30 17:51:13 +00:00
|
|
|
# Build scripts that publish pre-compiled protoc artifacts
|
|
|
|
``protoc`` is the compiler for ``.proto`` files. It generates language bindings
|
|
|
|
for the messages and/or RPC services from ``.proto`` files.
|
|
|
|
|
|
|
|
Because ``protoc`` is a native executable, the scripts under this directory
|
|
|
|
build and publish a ``protoc`` executable (a.k.a. artifact) to Maven
|
2015-03-30 17:57:00 +00:00
|
|
|
repositories. The artifact can be used by build automation tools so that users
|
|
|
|
would not need to compile and install ``protoc`` for their systems.
|
|
|
|
|
|
|
|
## Versioning
|
|
|
|
The version of the ``protoc`` artifact must be the same as the version of the
|
|
|
|
Protobuf project.
|
2015-03-30 17:51:13 +00:00
|
|
|
|
|
|
|
## Artifact name
|
|
|
|
The name of a published ``protoc`` artifact is in the following format:
|
|
|
|
``protoc-<version>-<os>-<arch>.exe``, e.g., ``protoc-3.0.0-alpha-3-windows-x86_64.exe``.
|
|
|
|
|
2015-03-30 18:02:02 +00:00
|
|
|
## System requirement
|
2015-04-01 19:06:24 +00:00
|
|
|
Install [Apache Maven](http://maven.apache.org/) if you don't have it.
|
|
|
|
|
|
|
|
The scripts only work under Unix-like environments, e.g., Linux, MacOSX, and
|
2015-03-30 18:02:02 +00:00
|
|
|
Cygwin or MinGW for Windows. Please see ``README.md`` of the Protobuf project
|
|
|
|
for how to set up the build environment.
|
|
|
|
|
2016-05-11 23:18:26 +00:00
|
|
|
## Building from a freshly checked-out source
|
|
|
|
|
|
|
|
If you just checked out the Protobuf source from github, you need to
|
2016-05-13 00:55:29 +00:00
|
|
|
generate the configure script.
|
2016-05-11 23:18:26 +00:00
|
|
|
|
|
|
|
Under the protobuf project directory:
|
|
|
|
|
|
|
|
```
|
|
|
|
$ ./autogen.sh && ./configure && make
|
|
|
|
```
|
|
|
|
|
2015-03-30 17:51:13 +00:00
|
|
|
## To install artifacts locally
|
|
|
|
The following command will install the ``protoc`` artifact to your local Maven repository.
|
|
|
|
```
|
2015-04-01 19:06:24 +00:00
|
|
|
$ mvn install
|
2015-03-30 17:51:13 +00:00
|
|
|
```
|
|
|
|
|
2015-04-01 23:32:21 +00:00
|
|
|
## Cross-compilation
|
|
|
|
The Maven script will try to detect the OS and the architecture from Java
|
2015-04-02 17:25:13 +00:00
|
|
|
system properties. It's possible to build a protoc binary for an architecture
|
2015-04-01 23:32:21 +00:00
|
|
|
that is different from what Java has detected, as long as you have the proper
|
2015-04-02 20:14:29 +00:00
|
|
|
compilers installed.
|
|
|
|
|
|
|
|
You can override the Maven properties ``os.detected.name`` and
|
|
|
|
``os.detected.arch`` to force the script to generate binaries for a specific OS
|
|
|
|
and/or architecture. Valid values are defined as the return values of
|
|
|
|
``normalizeOs()`` and ``normalizeArch()`` of ``Detector`` from
|
|
|
|
[os-maven-plugin](https://github.com/trustin/os-maven-plugin/blob/master/src/main/java/kr/motd/maven/os/Detector.java).
|
|
|
|
Frequently used values are:
|
|
|
|
- ``os.detected.name``: ``linux``, ``osx``, ``windows``.
|
|
|
|
- ``os.detected.arch``: ``x86_32``, ``x86_64``
|
|
|
|
|
2016-05-11 23:18:26 +00:00
|
|
|
For example, MinGW32 only ships with 32-bit compilers, but you can still build
|
2015-04-02 20:14:29 +00:00
|
|
|
32-bit protoc under 64-bit Windows, with the following command:
|
2015-04-01 23:32:21 +00:00
|
|
|
```
|
|
|
|
$ mvn install -Dos.detected.arch=x86_32
|
|
|
|
```
|
|
|
|
|
2015-03-30 17:51:13 +00:00
|
|
|
## To push artifacts to Maven Central
|
2015-04-01 19:06:24 +00:00
|
|
|
Before you can upload artifacts to Maven Central repository, make sure you have
|
|
|
|
read [this page](http://central.sonatype.org/pages/apache-maven.html) on how to
|
2015-04-02 17:25:13 +00:00
|
|
|
configure GPG and Sonatype account.
|
2015-03-30 17:51:13 +00:00
|
|
|
|
2015-04-06 21:31:29 +00:00
|
|
|
You need to perform the deployment for every platform that you want to
|
2016-01-11 22:52:01 +00:00
|
|
|
support. DO NOT close the staging repository until you have done the
|
2015-04-08 00:18:46 +00:00
|
|
|
deployment for all platforms. Currently the following platforms are supported:
|
|
|
|
- Linux (x86_32 and x86_64)
|
|
|
|
- Windows (x86_32 and x86_64) with
|
2016-05-11 23:18:26 +00:00
|
|
|
- Cygwin64 with MinGW compilers (x86_64)
|
|
|
|
- MSYS with MinGW32 (x86_32)
|
2015-04-08 00:18:46 +00:00
|
|
|
- MacOSX (x86_32 and x86_64)
|
2015-04-06 21:31:29 +00:00
|
|
|
|
2016-05-11 23:18:26 +00:00
|
|
|
As for MSYS2/MinGW64 for Windows: protoc will build, but it insists on
|
|
|
|
adding a dependency of `libwinpthread-1.dll`, which isn't shipped with
|
|
|
|
Windows.
|
|
|
|
|
2015-04-06 21:31:29 +00:00
|
|
|
Use the following command to deploy artifacts for the host platform to a
|
|
|
|
staging repository.
|
2015-03-30 17:51:13 +00:00
|
|
|
```
|
2015-04-01 19:06:24 +00:00
|
|
|
$ mvn clean deploy -P release
|
2015-03-30 17:51:13 +00:00
|
|
|
```
|
2015-04-06 21:31:29 +00:00
|
|
|
It creates a new staging repository. Go to
|
|
|
|
https://oss.sonatype.org/#stagingRepositories and find the repository, usually
|
|
|
|
in the name like ``comgoogle-123``.
|
|
|
|
|
|
|
|
You will want to run this command on a different platform. Remember, in
|
|
|
|
subsequent deployments you will need to provide the repository name that you
|
|
|
|
have found in the first deployment so that all artifacts go to the same
|
|
|
|
repository:
|
|
|
|
```
|
|
|
|
$ mvn clean deploy -P release -Dstaging.repository=comgoogle-123
|
|
|
|
```
|
|
|
|
|
|
|
|
A 32-bit artifact can be deployed from a 64-bit host with
|
|
|
|
``-Dos.detected.arch=x86_32``
|
|
|
|
|
|
|
|
When you have done deployment for all platforms, go to
|
|
|
|
https://oss.sonatype.org/#stagingRepositories, verify that the staging
|
|
|
|
repository has all the binaries, close and release this repository.
|
|
|
|
|
2016-07-25 21:55:36 +00:00
|
|
|
## Upload zip packages to github release page.
|
|
|
|
After uploading protoc artifacts to Maven Central repository, run the
|
|
|
|
build-zip.sh script to bulid zip packages for these protoc binaries
|
|
|
|
and upload these zip packages to the download section of the github
|
|
|
|
release. For example:
|
|
|
|
```
|
|
|
|
$ ./build-zip.sh 3.0.0-beta-4
|
|
|
|
```
|
|
|
|
The above command will create 5 zip files:
|
|
|
|
```
|
|
|
|
dist/protoc-3.0.0-beta-4-win32.zip
|
|
|
|
dist/protoc-3.0.0-beta-4-osx-x86_32.zip
|
|
|
|
dist/protoc-3.0.0-beta-4-osx-x86_64.zip
|
|
|
|
dist/protoc-3.0.0-beta-4-linux-x86_32.zip
|
|
|
|
dist/protoc-3.0.0-beta-4-linux-x86_64.zip
|
|
|
|
```
|
|
|
|
Before running the script, make sure the artifacts are accessible from:
|
|
|
|
http://repo1.maven.org/maven2/com/google/protobuf/protoc/
|
|
|
|
|
2015-05-12 00:13:59 +00:00
|
|
|
### Tips for deploying on Linux
|
|
|
|
We build on Centos 6.6 to provide a good compatibility for not very new
|
|
|
|
systems. We have provided a ``Dockerfile`` under this directory to build the
|
|
|
|
environment. It has been tested with Docker 1.6.1.
|
|
|
|
|
|
|
|
To build a image:
|
|
|
|
```
|
|
|
|
$ docker build -t protoc-artifacts .
|
|
|
|
```
|
|
|
|
|
|
|
|
To run the image:
|
|
|
|
```
|
|
|
|
$ docker run -it --rm=true protoc-artifacts
|
|
|
|
```
|
|
|
|
|
|
|
|
The Protobuf repository has been cloned into ``/protobuf``.
|
|
|
|
|
2015-04-06 21:31:29 +00:00
|
|
|
### Tips for deploying on Windows
|
|
|
|
Under Windows the following error may occur: ``gpg: cannot open tty `no tty':
|
|
|
|
No such file or directory``. This can be fixed by configuring gpg through an
|
|
|
|
active profile in ``.m2\settings.xml`` where also the Sonatype password is
|
|
|
|
stored:
|
|
|
|
```xml
|
|
|
|
<settings>
|
|
|
|
<servers>
|
|
|
|
<server>
|
2016-05-12 23:39:49 +00:00
|
|
|
<id>sonatype-nexus-staging</id>
|
2015-04-06 21:31:29 +00:00
|
|
|
<username>[username]</username>
|
|
|
|
<password>[password]</password>
|
|
|
|
</server>
|
|
|
|
</servers>
|
|
|
|
<profiles>
|
|
|
|
<profile>
|
|
|
|
<id>gpg</id>
|
|
|
|
<properties>
|
|
|
|
<gpg.executable>gpg</gpg.executable>
|
|
|
|
<gpg.passphrase>[password]</gpg.passphrase>
|
|
|
|
</properties>
|
|
|
|
</profile>
|
|
|
|
</profiles>
|
|
|
|
<activeProfiles>
|
|
|
|
<activeProfile>gpg</activeProfile>
|
|
|
|
</activeProfiles>
|
|
|
|
</settings>
|
|
|
|
```
|
2015-04-17 00:30:07 +00:00
|
|
|
|
|
|
|
### Tested build environments
|
2016-01-11 22:52:01 +00:00
|
|
|
We have successfully built artifacts on the following environments:
|
2015-05-12 00:13:59 +00:00
|
|
|
- Linux x86_32 and x86_64:
|
|
|
|
- Centos 6.6 (within Docker 1.6.1)
|
|
|
|
- Ubuntu 14.04.2 64-bit
|
2015-04-17 00:30:07 +00:00
|
|
|
- Windows x86_32: MSYS with ``mingw32-gcc-g++ 4.8.1-4`` on Windows 7 64-bit
|
|
|
|
- Windows x86_64: Cygwin64 with ``mingw64-x86_64-gcc-g++ 4.8.3-1`` on Windows 7 64-bit
|
|
|
|
- Mac OS X x86_32 and x86_64: Mac OS X 10.9.5
|