Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
amenocal committed Dec 19, 2023
1 parent 84fc81c commit 8822818
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,8 @@ Usage:
gh workflows [flags]

Flags:
-h, --help help for workflows
-h, --help help for workflows
-o, --overwrite overwrite existing workflow files

Global Flags:
-d, --debug debug mode - set logger to debug level
Expand All @@ -79,7 +80,7 @@ gh pin-actions workflows
```

>**Note**
>Currently `gh pin-actions` will create a new file within your `.github/workflows` directory with the suffix `-pin`. This is to ensure that you can review the changes before committing them to your repository. Once you have reviewed the changes, you can delete the original workflow file and rename the `-pin` file to the original workflow file name.
>`gh pin-actions` will create a new file within your `.github/workflows` directory with the suffix `-pin`. This is to ensure that you can review the changes before committing them to your repository. Once you have reviewed the changes, you can then pass the `--overwrite` flag to overwrite your existing workflow files with the pin shas.
## Contributing

Expand Down

0 comments on commit 8822818

Please sign in to comment.