Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
pcgeek86 authored Sep 29, 2020
1 parent dc5daed commit 740cb71
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,20 @@
# publish-powershell-module-action
## Publish PowerShell Module

This GitHub Action enables you to publish a PowerShell module to the [PowerShell Gallery](https://powershellgallery.com).

## Usage

1. Add a GitHub Actions Workflow configuration to your GitHub project, under `.github/workflows/main.yml`
2. Configure a secret on your GitHub repository, containing your PowerShell Gallery NuGet API key
3. Add the following step to your GitHub Actions job

For example, if you named your secret `PS_GALLERY_KEY`:

```
- name: Publish Module to PowerShell Gallery
uses: pcgeek86/publish-powershell-module-action@v19
id: publish-module
with:
modulePath: YOURMODULENAME
NuGetApiKey: ${{ secrets.PS_GALLERY_KEY }}
```

0 comments on commit 740cb71

Please sign in to comment.