Skip to content

Commit 3fc0a9c

Browse files
committed
docs(publisher): add example for GitHub publish target
1 parent d1ceadf commit 3fc0a9c

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -178,6 +178,18 @@ the JS file method mentioned above then you can use functions normally.
178178
|-------------|-------------|-----------------|
179179
| github | Makes a new release for the current version (if required) and uploads the make artifacts as release assets | `process.env.GITHUB_TOKEN` - A personal access token with access to your releases <br />`forge.github_repository.owner` - The owner of the GitHub repository<br />`forge.github_repository.name` - The name of the GitHub repository <br />`forge.github_repository.draft` - Create the release as a draft, defaults to `true` <br />`forge.github_repository.prerelease` - Identify the release as a prerelease, defaults to `false` |
180180

181+
For example:
182+
183+
```javascript
184+
{
185+
// Assume the GitHub repository is at https://github.com/username/repo
186+
"github_repository": {
187+
"owner": "username",
188+
"name": "repo"
189+
}
190+
}
191+
```
192+
181193
## Custom `make` and `publish` targets
182194

183195
You can make your own custom targets for the `make` and `publish` targets. If you publish them as `electron-forge-publisher-{name}` or `electron-forge-maker-{name}` you can then just specify `{name}` as your make / publish target. The API for each is documented below.

0 commit comments

Comments
 (0)