Skip to content

Commit 56cab05

Browse files
committed
doc: document bin/octodiff-docker.sh
Ref #3
1 parent 5209406 commit 56cab05

File tree

1 file changed

+31
-15
lines changed

1 file changed

+31
-15
lines changed

doc/puppet.md

Lines changed: 31 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -162,26 +162,42 @@ private repository (and remember to commit that change).
162162

163163
[octocatalog-diff]: https://github.com/github/octocatalog-diff/
164164

165-
Then, run octocatalog-diff like so:
165+
Then, run `./bin/octodiff-docker.sh`, enter the username/password, and
166+
run `octocatalog-diff` commands like so:
166167

167168
```shell
168-
$ export PUPPETDB_URL="https://username:[email protected]:8100/"
169+
# staging
170+
octocatalog-diff -n codeorigin-02.stage.ops.jquery.net
169171
170-
$ octocatalog-diff -n codeorigin-02.stage.ops.jquery.net
171-
$ octocatalog-diff --environment production -n codeorigin-02.ops.jquery.net
172+
# production
173+
octocatalog-diff --environment production -n codeorigin-02.ops.jquery.net
174+
175+
# production (verbose)
176+
octocatalog-diff --environment production -n codeorigin-02.ops.jquery.net --display-detail-add
172177
```
173178

174179
By default, `octocatalog-diff` will show the difference between the
175180
current working tree and the last commit pushed to `origin`.
176181

177-
`octocatalog-diff` requires a local installation of Puppet 7. On a
178-
Debian Bookworm (testing) setup, as of time of writing you need the
179-
following packages:
180-
181-
```
182-
git
183-
octocatalog-diff
184-
puppet-agent
185-
puppet-module-puppetlabs-sshkeys-core
186-
g10k
187-
```
182+
Alternatively, you can install octocatalog-diff yourself:
183+
184+
* Install `octocatalog-diff` package (e.g. from apt-get).
185+
* octocatalog-diff requires a local installation of Puppet 7.
186+
Debian 12 Bookworm, you need the following packages:
187+
```
188+
git
189+
puppet-agent
190+
puppet-module-puppetlabs-sshkeys-core
191+
g10k
192+
```
193+
* Provide your username and passwowrd via the environment:
194+
```shell
195+
export PUPPETDB_URL="https://username:[email protected]:8100/"
196+
```
197+
* Then, run `g10k` once on the jquery/infrastructure-puppet directory, and
198+
then you can use the`octocatalog-diff` command like above.
199+
```
200+
$ cd /path/to/jquery/infrastructure-puppet
201+
$ g10k -puppetfile
202+
$ octocatalog-diff -n codeorigin-02.stage.ops.jquery.net
203+
```

0 commit comments

Comments
 (0)