Skip to content

Commit 3d17465

Browse files
Fix Build module description: correct sequence, remove downstream commentary
1 parent 19b2789 commit 3d17465

1 file changed

Lines changed: 13 additions & 14 deletions

File tree

README.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -122,9 +122,8 @@ object — including version data under `Settings.Module` — that every downstr
122122

123123
[workflow](./.github/workflows/Build-Module.yml)
124124

125-
- Receives the resolved version from `Settings.Module` and stamps it into the module manifest before the artifact is uploaded.
126-
- Compiles the module source code into a PowerShell module.
127-
- Produces the artifact that flows unchanged through test and publish stages.
125+
- Compiles the module source code into a PowerShell module, stamping the version from `Settings.Module` into the manifest.
126+
- Uploads the built artifact.
128127

129128
### Test source code
130129

@@ -406,16 +405,16 @@ jobs:
406405

407406
The following secrets are used by the workflow. They can be automatically provided (if available) by setting `secrets: inherit` in the workflow file.
408407

409-
| Name | Location | Description | Default |
410-
| ---- | -------------- | ------------------------------------------------------------------------- | ------- |
411-
| `APIKEY` | GitHub secrets | The API key for the PowerShell Gallery. | N/A |
412-
| `TEST_APP_ENT_CLIENT_ID` | GitHub secrets | The client ID of an Enterprise GitHub App for running tests. | N/A |
413-
| `TEST_APP_ENT_PRIVATE_KEY` | GitHub secrets | The private key of an Enterprise GitHub App for running tests. | N/A |
414-
| `TEST_APP_ORG_CLIENT_ID` | GitHub secrets | The client ID of an Organization GitHub App for running tests. | N/A |
415-
| `TEST_APP_ORG_PRIVATE_KEY` | GitHub secrets | The private key of an Organization GitHub App for running tests. | N/A |
416-
| `TEST_USER_ORG_FG_PAT` | GitHub secrets | The fine-grained PAT with organization access for running tests. | N/A |
417-
| `TEST_USER_USER_FG_PAT` | GitHub secrets | The fine-grained PAT with user account access for running tests. | N/A |
418-
| `TEST_USER_PAT` | GitHub secrets | The classic personal access token for running tests. | N/A |
408+
| Name | Location | Description |
409+
| -------------------------- | -------------- | ---------------------------------------------------------------- |
410+
| `APIKEY` | GitHub secrets | The API key for the PowerShell Gallery. |
411+
| `TEST_APP_ENT_CLIENT_ID` | GitHub secrets | The client ID of an Enterprise GitHub App for running tests. |
412+
| `TEST_APP_ENT_PRIVATE_KEY` | GitHub secrets | The private key of an Enterprise GitHub App for running tests. |
413+
| `TEST_APP_ORG_CLIENT_ID` | GitHub secrets | The client ID of an Organization GitHub App for running tests. |
414+
| `TEST_APP_ORG_PRIVATE_KEY` | GitHub secrets | The private key of an Organization GitHub App for running tests. |
415+
| `TEST_USER_ORG_FG_PAT` | GitHub secrets | The fine-grained PAT with organization access for running tests. |
416+
| `TEST_USER_USER_FG_PAT` | GitHub secrets | The fine-grained PAT with user account access for running tests. |
417+
| `TEST_USER_PAT` | GitHub secrets | The classic personal access token for running tests. |
419418

420419
### Permissions
421420

@@ -547,7 +546,7 @@ The following settings are available in the settings file:
547546
| Name | Type | Description | Default |
548547
| ----------------------------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- |
549548
| `Name` | `String` | Name of the module to publish. Defaults to the repository name. | `null` |
550-
| `ImportantFilePatterns` | `Array` | Regular expression patterns that identify important files. Changes matching these patterns trigger build, test, and publish stages. When set, fully replaces the defaults. | `['^src/', '^README\.md$']` |
549+
| `ImportantFilePatterns` | `Array` | Regular expression patterns that identify important files. Changes matching these patterns trigger build, test, and publish stages. When set, fully replaces the defaults. | `['^src/', '^README\.md$']` |
551550
| `Test.Skip` | `Boolean` | Skip all tests | `false` |
552551
| `Test.Linux.Skip` | `Boolean` | Skip tests on Linux | `false` |
553552
| `Test.MacOS.Skip` | `Boolean` | Skip tests on macOS | `false` |

0 commit comments

Comments
 (0)