Skip to content

Commit 11086e9

Browse files
committed
Update README documentation to show publishing to plugin registry
Signed-off-by: Tom Sellman <[email protected]>
1 parent 23329a8 commit 11086e9

File tree

2 files changed

+5
-10
lines changed

2 files changed

+5
-10
lines changed

README.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -36,13 +36,9 @@ nextflowPlugin {
3636
]
3737
3838
publishing {
39-
github {
40-
repository = 'example-inc/nf-example'
41-
userName = project.findProperty('github_username')
42-
authToken = project.findProperty('github_access_token')
43-
email = project.findProperty('github_commit_email')
44-
45-
indexUrl = 'https://github.com/nextflow-io/plugins/main/plugins.json'
39+
registry {
40+
url = 'https://plugins.nextflow.io/api'
41+
authToken = project.findProperty('registry_access_token')
4642
}
4743
}
4844
}
@@ -51,7 +47,7 @@ nextflowPlugin {
5147
This will add some useful tasks to your Gradle build:
5248
* `assemble` - compile the Nextflow plugin code and assemble it into a zip file
5349
* `installPlugin` - copy the assembled plugin into your local Nextflow plugins dir
54-
* `releasePlugin` - published the assembled plugin to a Github repository, and update the central plugins.json index repository
50+
* `releasePlugin` - publish the assembled plugin to the plugin registry
5551

5652
You should also ensure that your project's `settings.gradle` declares the plugin name, eg:
5753
```gradle

src/main/groovy/io/nextflow/gradle/registry/RegistryPublishConfig.groovy

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,7 @@ class RegistryPublishConfig {
1010
/**
1111
* Location of the registry api
1212
*/
13-
// replace this with default registry url
14-
String url = 'http://localhost:8080'
13+
String url = 'https://plugins.nextflow.io/api'
1514

1615
/**
1716
* Registry authentication token

0 commit comments

Comments
 (0)