From 65858d51bbea49c19f0c2a1d4c223b781ea688f7 Mon Sep 17 00:00:00 2001 From: zhangkun83 Date: Mon, 30 Mar 2015 10:51:13 -0700 Subject: Add README.md; Allow installing to local repo without OSSRH account and signature --- protoc-artifacts/README.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 protoc-artifacts/README.md (limited to 'protoc-artifacts/README.md') diff --git a/protoc-artifacts/README.md b/protoc-artifacts/README.md new file mode 100644 index 00000000..136ae4a6 --- /dev/null +++ b/protoc-artifacts/README.md @@ -0,0 +1,38 @@ +# 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 +repositories. + +## Artifact name +The name of a published ``protoc`` artifact is in the following format: +``protoc---.exe``, e.g., ``protoc-3.0.0-alpha-3-windows-x86_64.exe``. + +## To install artifacts locally +The following command will install the ``protoc`` artifact to your local Maven repository. +``` +$ ./gradlew install +``` + +## To push artifacts to Maven Central +Before you can upload artifacts to Maven Central repository, you must have [set +up your account with OSSRH](http://central.sonatype.org/pages/ossrh-guide.html), +and have [generated a PGP key](http://gradle.org/docs/current/userguide/signing_plugin.html) +for siging. You need to put your account information and PGP key information +in ``$HOME/.gradle/gradle.properties``, e.g.: +``` +signing.keyId=24875D73 +signing.password=secret +signing.secretKeyRingFile=/Users/me/.gnupg/secring.gpg + +ossrhUsername=your-jira-id +ossrhPassword=your-jira-password +``` + +Use the following command to upload artifacts: +``` +$ ./gradlew uploadArchives +``` + -- cgit v1.2.3