Merge pull request #1 from mona-actions/feature/create-issue-on-target

v0.0.7 Pre-Release

README.md

@@ -9,6 +9,8 @@ Will report on:
    - Variables
    - Environments
 
+Optionally you can choose to create a CSV in your file system (`-c` flag) and/or an issue (`-i` flag) in the target repo with the results.
+
 The tool could be expanded to include other non-migratable settings (see [what is & isn't migrated](https://docs.github.com/en/migrations/using-github-enterprise-importer/understanding-github-enterprise-importer/migration-support-for-github-enterprise-importer#githubcom-migration-support) during a migration with [GEI](https://github.com/github/gh-gei)), and most likely will in the near future.
 
 [![build](https://github.com/mona-actions/gh-pma/actions/workflows/build.yaml/badge.svg)](https://github.com/mona-actions/gh-pma/actions/workflows/build.yaml)
@@ -19,7 +21,6 @@ The tool could be expanded to include other non-migratable settings (see [what i
    - Codespaces Secrets
    - Dependabot Secrets
    - Environmen Secrets & Vars (currently just Environments are detected)
-- Create an issue on the target org repository with the list of items to mitigate.
 
 ## Prerequisites
 - [GitHub CLI](https://cli.github.com/manual/installation) installed.
@@ -53,13 +54,15 @@ Usage:
   gh pma [flags]
 
 Flags:
-      --confirm                    Auto respond to confirmation prompt
+      --confirm                    Auto respond to visibility alignment confirmation prompt
+  -c, --create-csv                 Whether to create a CSV file with the results.
+  -i, --create-issues              Whether to create issues in target org repositories or not.
       --ghes-api-url string        Required if migrating from GHES. The domain name for your GHES instance. For example: ghes.contoso.com (default "github.com")
       --github-source-org string   Uses GH_SOURCE_PAT env variable or --github-source-pat option. Will fall back to GH_PAT or --github-target-pat if not set.
       --github-source-pat string   
       --github-target-org string   Uses GH_PAT env variable or --github-target-pat option.
       --github-target-pat string   
   -h, --help                       help for gh
-  -t, --threads int                Number of threads to process concurrently. Maximum of 10 allowed. Increasing this number could get your PAT blocked due to API limiting. (default 3)
+      --threads int                Number of threads to process concurrently. Maximum of 10 allowed. Increasing this number could get your PAT blocked due to API limiting. (default 3)
   -v, --version                    version for gh
 ```