You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/ScriptModuleRepositoryTemplate/TemplateRepoFiles/ReadMe.md
+7-4Lines changed: 7 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -64,8 +64,9 @@ If using GitHub Actions for your CI/CD workflows, perform the following steps to
64
64
1. Go to the `Settings` tab for your repository.
65
65
1. In the left-hand menu, in the `Security` section, click on `Secrets and variables` and select `Actions`.
66
66
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.
67
68
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.
69
70
70
71
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:
71
72
@@ -78,11 +79,12 @@ error: Response status code does not indicate success: 403 (The specified API ke
78
79
Next we want to create an Environment so that stable module versions require manual approval before being published to the gallery:
79
80
80
81
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`.
82
83
1. Click the `New environment` button.
83
84
1. Set the `Name` to (all lowercase): `production`
84
85
1. Click the `Configure environment` button.
85
86
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.
86
88
1. Click the `Save protection rules` button.
87
89
88
90
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
94
96
1. You should still be in the `Settings` section of your repository.
95
97
1. In the left-hand menu, in the `Code and automation` section, click on `Actions` and select `General`.
96
98
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.
98
100
99
101
If you do not do this you will get the following error in the `Set the new version tag` step of the deployment workflow:
100
102
@@ -127,7 +129,8 @@ The following boilerplate git repository files should be reviewed and updated or
127
129
128
130
> [!IMPORTANT]
129
131
> 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.
0 commit comments