You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/gradle-plugin.md
+12-16Lines changed: 12 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -65,25 +65,21 @@ To run unit tests:
65
65
66
66
## Packaging, uploading, and publishing a plugin
67
67
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.
69
69
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
+
:::
71
73
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.
Copy file name to clipboardExpand all lines: docs/migrating-gradle-plugin.md
+10-11Lines changed: 10 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,10 +15,14 @@ The Gradle plugin for Nextflow plugins simplifies and standardizes the developme
15
15
16
16
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.
17
17
18
-
### Nextflow plugin registry
18
+
### Nextflow Plugin Registry
19
19
20
20
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.
21
21
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
+
22
26
## Impact on users and developers
23
27
24
28
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:
57
61
```groovy
58
62
// Plugins
59
63
plugins {
60
-
id 'io.nextflow.nextflow-plugin' version '0.0.1-alpha3'
64
+
id 'io.nextflow.nextflow-plugin' version '0.0.1-alpha4'
61
65
}
62
66
63
67
// Dependencies (optional)
@@ -79,13 +83,10 @@ To migrate an existing Nextflow plugin:
@@ -99,8 +100,6 @@ To migrate an existing Nextflow plugin:
99
100
- `PROVIDER`: Your name or organization—for example, `acme`.
100
101
- `CLASS_NAME`: Your plugin class name—for example, `acme.plugin.MyPlugin`.
101
102
- `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).
104
103
105
104
5. Replace the contents of `Makefile` with the following:
0 commit comments