This repository contains many scripts for builds, releases, continuous integration, etc. This file describes the environment prerequisites for those scripts.
Installing some of the dependencies can be tricky, particularly on
restricted internal versions of Linux. For that reason, we provide a
Dockerfile to get started with, which has
bash as an entry point. The typical procedure would be:
git clone --recursive https://github.com/googleapis/google-cloud-dotnet.gitcd google-cloud-dotnetdocker build -t google-cloud-dotnet dockerdocker run -v $PWD:/google-cloud-dotnet -it google-cloud-dotnet
Building the Docker image the first time can be slow, but it should work without intervention.
The last line will start a Docker container mounting the current
directory in the host system as /google-cloud-dotnet. This allows
you to make changes (e.g. generating an API or building a NuGet
package) and then use your regular environment to create a pull
request, upload the package somewhere etc.
We mostly develop on Windows and Linux. When building on Linux, we don't build libraries targeting the full desktop .NET framework; that may change when reference assemblies are no longer in preview.
On Windows, please run scripts under the version of bash that comes
with Git for Windows.
The scripts here should work on OS X as well, but we haven't tried them. Please file an issue if you run into problems.
The version of the .NET Core SDK required is specified in global.json.
This is required for synthtool and other aspects of API generation
(generateapis.sh). It expected to be available via just python, py 3 or python3.
It's expected that pip is also installed.
The following common tools are expected to be available:
bashgitcurl