Skip to content

Commit a71ffcc

Browse files
christopher-hakkaartbentsherman
authored andcommitted
Only support registry
Signed-off-by: Christopher Hakkaart <chris.hakkaart@seqera.io>
1 parent a14e237 commit a71ffcc

File tree

4 files changed

+24
-29
lines changed

4 files changed

+24
-29
lines changed

docs/gradle-plugin.md

Lines changed: 12 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -65,25 +65,21 @@ To run unit tests:
6565

6666
## Packaging, uploading, and publishing a plugin
6767

68-
The Gradle plugin for Nextflow plugins simplifies publishing your plugin.
68+
The Gradle plugin for Nextflow plugins simplifies publishing your plugin to the Nextflow Plugin Registry.
6969

70-
To package, upload, and publish your plugin:
70+
:::{note}
71+
The Nextflow Plugin Registry is currently available as private beta technology. Contact [info@nextflow.io](mailto:info@nextflow.io) to learn how to get access.
72+
:::
7173

72-
1. Fork the [Nextfow plugins index repository](https://github.com/nextflow-io/plugins).
73-
2. In the plugin root directory, open `build.gradle` and ensure that:
74-
* `github.repository` matches the plugin repository.
75-
* `github.indexUrl` matches your fork of the plugins index repository.
76-
3. Create a file named `$HOME/.gradle/gradle.properties` and add the following:
74+
To package, upload, and publish your plugin to the Nextflow Plugin Registry:
75+
76+
1. Create a file named `$HOME/.gradle/gradle.properties`, where `$HOME` is your home directory.
77+
2. Add the following properties:
7778

7879
```bash
79-
github_username=<GITHUB_USERNAME>
80-
github_access_token=<GITHUB_ACCESS_TOKEN>
81-
github_commit_email=<GITHUB_EMAIL>
80+
pluginRegistry.accessToken=<REGISTRY_ACCESS_TOKEN>
8281
```
8382

84-
Replace the following:
85-
* `GITHUB_USERNAME`: your GitHub username granting access to the plugin repository.
86-
* `GITHUB_ACCESS_TOKEN`: your GitHub access token with permission to upload and commit changes to the plugin repository.
87-
* `GITHUB_EMAIL`: your email address associated with your GitHub account.
88-
4. Run `make release`.
89-
5. Create a pull request against the [Nextfow plugins index repository](https://github.com/nextflow-io/plugins) from your fork.
83+
Replace <REGISTRY_ACCESS_TOKEN> with your plugin registry access token.
84+
85+
3. Run `make release`.

docs/migrating-gradle-plugin.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,14 @@ The Gradle plugin for Nextflow plugins simplifies and standardizes the developme
1515

1616
The Gradle plugin is versioned and published to the [Gradle Plugin Portal](https://plugins.gradle.org/), allowing developers to manage it like any other dependency. As the plugin ecosystem evolves, this Gradle plugin will enable easier maintenance and adoption of ongoing improvements to the Nextflow plugin framework.
1717

18-
### Nextflow plugin registry
18+
### Nextflow Plugin Registry
1919

2020
The Nextflow plugin registry is a centralized repository of assembled plugins. It hosts an index of plugin metadata that supports plugin discovery, accessibility, and version tracking. The registry is integrated with the Nextflow runtime. Nextflow will automatically locate and download configured plugins.
2121

22+
:::{note}
23+
The Nextflow Plugin Registry is currently available as private beta technology. Contact [info@nextflow.io](mailto:info@nextflow.io) to learn how to get access.
24+
:::
25+
2226
## Impact on users and developers
2327

2428
The impact of the Gradle plugin for Nextflow plugins differs for plugin users and developers.
@@ -57,7 +61,7 @@ To migrate an existing Nextflow plugin:
5761
```groovy
5862
// Plugins
5963
plugins {
60-
id 'io.nextflow.nextflow-plugin' version '0.0.1-alpha3'
64+
id 'io.nextflow.nextflow-plugin' version '0.0.1-alpha4'
6165
}
6266
6367
// Dependencies (optional)
@@ -79,13 +83,10 @@ To migrate an existing Nextflow plugin:
7983
'<EXTENSION_POINT>'
8084
]
8185
82-
publishing {
83-
github {
84-
repository = '<GITHUB_REPOSITORY>'
85-
userName = project.findProperty('github_username')
86-
authToken = project.findProperty('github_access_token')
87-
email = project.findProperty('github_commit_email')
88-
indexUrl = '<GITHUB_INDEX_URL>'
86+
publishing {
87+
registry {
88+
url = 'https://nf-plugins-registry.dev-tower.net/api'
89+
authToken = project.findProperty('pluginRegistry.accessToken')
8990
}
9091
}
9192
}
@@ -99,8 +100,6 @@ To migrate an existing Nextflow plugin:
99100
- `PROVIDER`: Your name or organization—for example, `acme`.
100101
- `CLASS_NAME`: Your plugin class name—for example, `acme.plugin.MyPlugin`.
101102
- `EXTENSION_POINT`: Your extension point identifiers that the plugin will implement or expose—for example, `acme.plugin.MyFactory`.
102-
- `GITHUB_REPOSITORY`: Your GitHub plugin repository name—for example, `nextflow-io/nf-plugin-template`.
103-
- `GITHUB_INDEX_URL`: The URL of your fork of the plugins index repository—for example, [`https://github.com/nextflow-io/plugins/blob/main/plugins.json`](https://github.com/nextflow-io/plugins/blob/main/plugins.json).
104103
105104
5. Replace the contents of `Makefile` with the following:
106105

docs/plugins/developing-plugins.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ The Gradle plugin is versioned and published to the [Gradle Plugin Portal](https
5656

5757
```nextflow
5858
plugins {
59-
id 'io.nextflow.nextflow-plugin' version '0.0.1-alpha3'
59+
id 'io.nextflow.nextflow-plugin' version '0.0.1-alpha4'
6060
}
6161
```
6262

docs/plugins/example-nf-hello.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ It also includes several classes that demonstrate different plugin functionality
5454
The `nf-hello` plugin can be configured via nextflow configuration files or at runtime. For example:
5555

5656
```bash
57-
nextflow run hello -plugins nf-hello@0.5.0,nf-amazon@2.9.0
57+
nextflow run hello -plugins nf-hello@0.5.0
5858
```
5959

6060
See the [nf-hello plugin repository](https://github.com/nextflow-io/nf-hello/tree/gradle-plugin-example) for the plugin source code.

0 commit comments

Comments
 (0)