From 88228185ed48726660207b8ee0abfe58f961a28f Mon Sep 17 00:00:00 2001 From: Alejandro Menocal Date: Tue, 19 Dec 2023 16:45:12 -0600 Subject: [PATCH] update docs --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 889f211..85d853b 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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