1- # Onboarding to Librarian
1+ # Onboarding to Legacy Librarian
22
33Welcome! This guide is intended to help you get started with the Librarian
44project and begin contributing effectively.
55
6- ## Step 1: Setup Environment to Run Librarian
6+ ## Step 1: Setup Environment to Run Legacy Librarian
77
88` librarian ` requires:
99
@@ -59,15 +59,15 @@ Read our guide on
5959[ How We Write Go] ( https://github.com/googleapis/librarian/blob/main/doc/howwewritego.md ) , for
6060[ project-specific guidance on writing idiomatic, consistent Go code.
6161
62- ## Step 6: Running Librarian
62+ ## Step 6: Running Legacy Librarian
6363
64- Currently running librarian from main is unstable, please use the v0.7 .0 tag when running
64+ Currently running legacy librarian from main is unstable, please use the v0.8 .0 tag when running
6565locally.
6666
6767### Using ` go run `
6868
6969``` sh
70- $ go run github.com/googleapis/librarian/cmd/librarian @v0.7 .0
70+ $ go run github.com/googleapis/librarian/cmd/legacylibrarian @v0.8 .0
7171```
7272
7373### Using ` go install `
@@ -76,7 +76,7 @@ To install a binary locally, and then run it (assuming the `$GOBIN` directory
7676is in your path):
7777
7878``` sh
79- $ go install github.com/googleapis/librarian/cmd/librarian @v0.7 .0
79+ $ go install github.com/googleapis/librarian/cmd/legacylibrarian @v0.8 .0
8080```
8181
8282
@@ -93,7 +93,7 @@ when running `librarian` you can use `gh auth token` to obtain an access
9393token and set it in the environment variable just for that invocation:
9494
9595``` sh
96- $ LIBRARIAN_GITHUB_TOKEN=$( gh auth token) librarian ...
96+ $ LIBRARIAN_GITHUB_TOKEN=$( gh auth token) legacylibrarian ...
9797```
9898
9999The examples below assume include this for convenience; if you have
@@ -102,17 +102,17 @@ set the environment variable in a different way, just remove the
102102
103103### Repository and library options
104104
105- ` librarian ` can either operate on a local clone of the library repo,
105+ ` legacylibrarian ` can either operate on a local clone of the library repo,
106106or it can clone the repo itself. Unless you have a particular need to use a
107107local clone (e.g. to the impact of a local change) we recommend you let
108- ` librarian ` clone the library repo itself, using the ` -repo ` flag - just specify
108+ ` legacylibrarian ` clone the library repo itself, using the ` -repo ` flag - just specify
109109the GitHub repository, e.g.
110110` -repo=https://github.com/googleapis/google-cloud-go ` . This avoids any
111111risk of unwanted local changes accidentally becoming part of a generation/release
112112pull request.
113113
114114If you wish to use a local clone, you can specify the directory in the ` -repo `
115- flag, or just run ` librarian ` from the root directory of the clone and omit the
115+ flag, or just run ` legacylibrarian ` from the root directory of the clone and omit the
116116` -repo ` flag entirely.
117117
118118The commands in this guide are specifically for generating/releasing a single
0 commit comments