kjuulh/cuddle-please
1
0
Fork 0
Code Issues 1 Pull Requests 3 Packages Projects Releases 6 Wiki Activity

docs: fix admonitions

Browse Source 
Signed-off-by: kjuulh <contact@kjuulh.io>
This commit is contained in:
Kasper Juul Hermansen 2023-08-02 14:16:23 +02:00
parent decdf5f777
commit 86f96460ee
Signed by: kjuulh
GPG Key ID: 9AA7BC13CE474394
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/getting-started.md
View File

@ -20,7 +20,8 @@ or docker (not public yet)
docker run -v $PWD:/mnt/src -e CUDDLE_PLEASE_TOKEN=<token> kjuulh/cuddle-please:latest docker run -v $PWD:/mnt/src -e CUDDLE_PLEASE_TOKEN=<token> kjuulh/cuddle-please:latest
``` ```
!!! warning Other distributions to be added. !!! warning
Other distributions to be added.
## Configuration ## Configuration
@ -58,9 +59,12 @@ The token needs to have write access to your repository, as well as the api.
Dry-run is used here to not commit any changes to your backend, it may still Dry-run is used here to not commit any changes to your backend, it may still
change your local git setup, but not the backends. Simply remove the arg if you change your local git setup, but not the backends. Simply remove the arg if you
want to commit. !!! note `--token` can also be set with want to commit.
`export CUDDLE_PLEASE_TOKEN='<personal-access-token>'` if you don't want to leak
the secret to your cli history. !!! note
`--token` can also be set with
`export CUDDLE_PLEASE_TOKEN='<personal-access-token>'` if you don't want to leak the secret to your cli history.
When run you should get output that it has created a dry_run pull-request, When run you should get output that it has created a dry_run pull-request,
meaning that it was supposed to do the action but didn't commit it. meaning that it was supposed to do the action but didn't commit it.