Skip to content

Commit 8aa091f

Browse files
committed
Update ReadMe instructions a bit to be more clear
1 parent de46208 commit 8aa091f

File tree

1 file changed

+7
-4
lines changed
  • src/ScriptModuleRepositoryTemplate/TemplateRepoFiles

1 file changed

+7
-4
lines changed

src/ScriptModuleRepositoryTemplate/TemplateRepoFiles/ReadMe.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,9 @@ If using GitHub Actions for your CI/CD workflows, perform the following steps to
6464
1. Go to the `Settings` tab for your repository.
6565
1. In the left-hand menu, in the `Security` section, click on `Secrets and variables` and select `Actions`.
6666
1. In the `Secrets` tab click the `New repository secret` button.
67+
1. Set the `Secret` value to the API key value that you copied in the previous section.
6768
1. Set the `Name` to: `POWERSHELL_GALLERY_API_KEY`
68-
1. Set the `Secret` to the API key value that you copied in the previous section.
69+
1. Click the `Add secret` button to save the repository secret.
6970

7071
If you do not provide a valid API key, you will get an error like the following in the `Publish prerelease PowerShell module` step of the deployment workflow:
7172

@@ -78,11 +79,12 @@ error: Response status code does not indicate success: 403 (The specified API ke
7879
Next we want to create an Environment so that stable module versions require manual approval before being published to the gallery:
7980

8081
1. You should still be in the `Settings` section of your repository.
81-
1. In the left-hand menu, in the `Environments` section, click on `Environments`.
82+
1. In the left-hand menu, in the `Code and automation` section, click on `Environments`.
8283
1. Click the `New environment` button.
8384
1. Set the `Name` to (all lowercase): `production`
8485
1. Click the `Configure environment` button.
8586
1. Check the `Required reviewers` checkbox and add the usernames of the people allowed to approve new stable version deployments.
87+
e.g. your GitHub username.
8688
1. Click the `Save protection rules` button.
8789

8890
If your GitHub account does not meet [the requirements to use `Environments`](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment), the `Environments` section will not be available.
@@ -94,7 +96,7 @@ Finally, we will need to grant GitHub Actions permission to add git tags to the
9496
1. You should still be in the `Settings` section of your repository.
9597
1. In the left-hand menu, in the `Code and automation` section, click on `Actions` and select `General`.
9698
1. Scroll down to `Workflow permissions` and ensure `Read and write permissions` is selected.
97-
1. Click the `Save` button.
99+
1. Click the `Save` button for the Workflow permissions.
98100

99101
If you do not do this you will get the following error in the `Set the new version tag` step of the deployment workflow:
100102

@@ -127,7 +129,8 @@ The following boilerplate git repository files should be reviewed and updated or
127129

128130
> [!IMPORTANT]
129131
> If you've made it this far, your repository is now ready for use! 🎉
130-
> You may delete this and all of the content above and commit any changes you've made.
132+
>
133+
> You may delete and all of this file's content above this message and commit any changes you've made.
131134
132135
# __NewModuleName__ PowerShell Module
133136

0 commit comments

Comments
 (0)