Skip to content

Commit e38164d

Browse files
Restore root README
Keep GitHub App and publishing credential guidance in the canonical documentation tree instead of the repository root README. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
1 parent ada4ac6 commit e38164d

1 file changed

Lines changed: 0 additions & 24 deletions

File tree

README.md

Lines changed: 0 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -11,27 +11,3 @@ The full documentation is published at:
1111
📖 **[Process-PSModule documentation](https://psmodule.io/docs/)**
1212

1313
It covers getting started, the pipeline stages, usage, configuration, repository structure, and the principles behind the framework.
14-
15-
## Reusable workflow secrets (GitHub App auth)
16-
17-
When calling `./.github/workflows/workflow.yml`, pass the PowerShell Gallery credential as `PSGALLERY_API_KEY` and GitHub App credentials using these reusable-workflow secret names:
18-
19-
- `PSGALLERY_API_KEY`
20-
- `GitHubAppClientId`
21-
- `GitHubAppPrivateKey`
22-
23-
Consumer repositories can keep their own secret names and map them in the caller workflow, for example:
24-
25-
```yaml
26-
jobs:
27-
ProcessPSModule:
28-
uses: ./.github/workflows/workflow.yml
29-
secrets:
30-
PSGALLERY_API_KEY: ${{ secrets.PSGALLERY_API_KEY }}
31-
GitHubAppClientId: ${{ secrets.SHELLY_CLIENT_ID }}
32-
GitHubAppPrivateKey: ${{ secrets.SHELLY_PRIVATE_KEY }}
33-
```
34-
35-
This is a required contract. `PSGALLERY_API_KEY` publishes the module to the PowerShell Gallery; the GitHub App credentials mint an installation token for GitHub operations via `GH_TOKEN`, with no `github.token` fallback in that path.
36-
37-
See the [GitHub App authentication guide](https://psmodule.io/docs/guides/github-app-authentication/) for the caller mapping, per-workflow permissions and repository scoping, and token injection details.

0 commit comments

Comments
 (0)