Skip to content

Commit

Permalink
admin: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
spiffxp committed Sep 27, 2021
1 parent 5ccc77c commit f8f6aea
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions admin/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@
Merge a PR that changes some `config/foo/org.yaml` and then run the following:
```shell
# Displays what it would do without making changes until you add the confirm flag
bazel run //admin:update -- --github-token-path ~/path-to-my-token # --confirm
./admin/update.sh --github-token-path ~/path-to-my-token # --confirm
```

This will default to a dry-run mode, displaying what changes it intends to make without actually updating anything on github.
It will apply the change if you send it the `--confirm` flag.

It also runs the `bazel test //config:all` unit tests to sanity check the config.
It also runs `make test` to validate the config.

Assuming everything works the tool should output something like the following:
```console
Expand Down

0 comments on commit f8f6aea

Please sign in to comment.