Skip to content

Commit bbb7133

Browse files
authored
docs: Revise librarian running instructions for stability (#2994)
Updated instructions for running librarian to recommend using the v0.7.0 tag for stability. Removed outdated alias and installation instructions. --------- Signed-off-by: ldetmer <[email protected]>
1 parent 0c58b22 commit bbb7133

File tree

1 file changed

+4
-28
lines changed

1 file changed

+4
-28
lines changed

doc/onboarding.md

Lines changed: 4 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -61,25 +61,13 @@ Read our guide on
6161

6262
## Step 6: Running Librarian
6363

64-
There are various options for running `librarian`. We recommend using `go run`
65-
(the first option) unless you're developing `librarian`. You may wish to use
66-
a bash alias for simplicity. For example, using the first option below you might
67-
use:
68-
69-
```sh
70-
$ alias librarian='go run github.com/googleapis/librarian/cmd/librarian@latest'
71-
```
72-
73-
In this guide, we just assume that `librarian` is either a binary in your path,
74-
or a suitable alias.
64+
Currently running librarian from main is unstable, please use the v0.7.0 tag when running
65+
locally.
7566

7667
### Using `go run`
7768

78-
The latest released version of `librarian` can be run directly without cloning
79-
using:
80-
8169
```sh
82-
$ go run github.com/googleapis/librarian/cmd/librarian@latest
70+
$ go run github.com/googleapis/librarian/cmd/librarian@v0.7.0
8371
```
8472

8573
### Using `go install`
@@ -88,21 +76,9 @@ To install a binary locally, and then run it (assuming the `$GOBIN` directory
8876
is in your path):
8977

9078
```sh
91-
$ go install github.com/googleapis/librarian/cmd/librarian@latest
79+
$ go install github.com/googleapis/librarian/cmd/librarian@v0.7.0
9280
```
9381

94-
Note that while this makes it easier to run `librarian`, you'll need to know
95-
to install a new version when it's released.
96-
97-
### Building locally
98-
99-
Clone the source code, then run it:
100-
101-
```sh
102-
$ git clone https://github.com/googleapis/librarian
103-
$ cd librarian
104-
$ go run ./cmd/librarian
105-
```
10682

10783
### Obtaining a GitHub access token
10884

0 commit comments

Comments
 (0)