Name: discovery-artifact-manager
Owner: Google APIs
Description: null
Created: 2016-11-03 17:17:02.0
Updated: 2018-05-24 00:02:35.0
Pushed: 2018-05-24 00:02:34.0
Homepage: null
Size: 50073
Language: Ruby
GitHub Committers
User | Most Recent Commit | # Commits |
---|
Other Committers
User | Most Recent Commit | # Commits |
---|
The Discovery Artifact Manager is intended to facilitate testing, publishing, and synchronization of generators and artifacts for client libraries and generated code samples of Google APIs defined by the API Discovery Service.
This repo includes copies of the following in separate top-level directories:
NOTE: This repo only contains a cache of the above items; it is not their source of truth. Changes to Toolkit and Discovery-based Google API client libraries should be directed to their respective repos. There is no guarantee that sources or Discovery files in this repo are up to date.
Install git-subrepo on your local machine.
Use the git subrepo clone
command, from the root directory of this repository. The NodeJS library, for example, is installed using:
subrepo clone https://github.com/google/google-api-nodejs-client.git clients/nodejs/google-api-nodejs-client
To make changes to a repo, use the git subrepo pull
and git subrepo push
commands. The former will merge your local client with fetched upstream changes, and the latter will actually do the push to the upstream sub-repo. For example, to push the PHP client library:
subrepo pull clients/php/google-api-php-client-services
subrepo push clients/php/google-api-php-client-services
During the course of your local work, you may find yourself deciding to reset your HEAD locally. If you do this after a subrepo push, trying to reset your HEAD to before the push, then this can cause some complications: you would not want github subrepo
to subsequently pull again, as it normally does when pushing (since that will merge the upstream changes you pushed earlier). Instead, you can force-push your changes by using git subrepo push --force
. We're still learning the quirks of git subrepo
, but a good rule of thumb is to be extremely careful when manipulating references that have already been synced (push or pull) with the external subrepo locations.
After you push your subrepo, you should also push discovery-artifact-manager
to your review branch.
When you make a change to code that lives in discovery-artifact-manager
, either directly or via subrepos, you should stage your code to your own Github review branch and then create a Pull Request from there to the Github master
branch.
${REVIEW_BRANCH}
.${LOCAL_BRANCH}
push origin ${LOCAL_BRANCH}:${REVIEW_BRANCH}
master
branch.To aid hermetic testing of client libraries and samples (avoiding synchronization issues), the discoveries
directory hosts a local cache of Discovery docs from the Discovery service. This cache may be updated from current live versions by running
c/main/updatedisco/updatedisco
from any subdirectory. This cache is not yet used for testing by other tools.