Skip to content

Commit 41a954c

Browse files
committed
adjust for new plugin registry
1 parent 1ba2220 commit 41a954c

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+258
-1015
lines changed

.gitignore

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,3 @@
66
# Ignore Gradle build output directory
77
build
88
work
9-
out
10-
11-
# Bactopia related
12-
/bactopia/

.gitpod.yml

Lines changed: 0 additions & 8 deletions
This file was deleted.

.pre-commit-config.yaml

Lines changed: 0 additions & 9 deletions
This file was deleted.

.prettierignore

Lines changed: 0 additions & 7 deletions
This file was deleted.

.prettierrc

Lines changed: 0 additions & 4 deletions
This file was deleted.

LICENSE

Lines changed: 0 additions & 202 deletions
This file was deleted.

Makefile

Lines changed: 14 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -1,64 +1,21 @@
1-
config ?= compileClasspath
2-
3-
ifdef module
4-
mm = :${module}:
5-
else
6-
mm =
7-
endif
1+
# Build the plugin
2+
assemble:
3+
./gradlew assemble
84

95
clean:
6+
rm -rf .nextflow*
7+
rm -rf work
8+
rm -rf build
109
./gradlew clean
1110

12-
compile:
13-
./gradlew :nextflow:exportClasspath compileGroovy
14-
@echo "DONE `date`"
15-
16-
17-
check:
18-
./gradlew check
19-
20-
21-
#
22-
# Show dependencies try `make deps config=runtime`, `make deps config=google`
23-
#
24-
deps:
25-
./gradlew -q ${mm}dependencies --configuration ${config}
26-
27-
deps-all:
28-
./gradlew -q dependencyInsight --configuration ${config} --dependency ${module}
29-
30-
#
31-
# Refresh SNAPSHOTs dependencies
32-
#
33-
refresh:
34-
./gradlew --refresh-dependencies
35-
36-
#
37-
# Run all tests or selected ones
38-
#
11+
# Run plugin unit tests
3912
test:
40-
ifndef class
41-
./gradlew ${mm}test
42-
else
43-
./gradlew ${mm}test --tests ${class}
44-
endif
45-
46-
#
47-
# generate build zips under build/plugins
48-
# you can install the plugin copying manually these files to $HOME/.nextflow/plugins
49-
#
50-
buildPlugins:
51-
./gradlew copyPluginZip
52-
53-
#
54-
# Upload JAR artifacts to Maven Central
55-
#
56-
upload:
57-
./gradlew upload
58-
13+
./gradlew test
5914

60-
upload-plugins:
61-
./gradlew plugins:upload
15+
# Install the plugin into local nextflow plugins dir
16+
install:
17+
./gradlew install
6218

63-
publish-index:
64-
./gradlew plugins:publishIndex
19+
# Publish the plugin
20+
release:
21+
./gradlew releasePlugin

README.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
# nf-bactopia
2+
23
A Nextflow plugin for specifically for usage with [Bactopia](https://bactopia.github.io/). It
34
based of the modified [nf-core libs](https://github.com/bactopia/bactopia/tree/4b075af96da522222bb075d4b65927d1ba3de9c2/lib)
45
and the [nf-schema plugin](https://github.com/nextflow-io/nf-schema).
56

67
This plugin will replicate the functionality of the previous libraries, while being compatible
7-
with the Nextflow strict syntax (Nextflow version >= 24).
8+
with future releases of Nextflow (>= 25).
89

910
Again, while you are free to do what you want, this plugin is specifically designed for Bactopia
1011
and will likely not work with other pipelines.
@@ -22,10 +23,22 @@ cd nf-bactopia
2223
### Create a new conda environment
2324

2425
```{bash}
25-
conda create -n nf-bactopia \
26+
conda create -y -n nf-bactopia \
2627
-c conda-forge \
2728
-c bioconda \
28-
gradle \
2929
make \
30-
'nextflow>=24'
30+
'nextflow>=25'
31+
conda activate nf-bactopia
32+
```
33+
34+
### Build the plugin
35+
36+
```{bash}
37+
make assemble
38+
```
39+
40+
### Use the plugin
41+
42+
```{bash}
43+
NXF_VER=25.06.0-edge NXF_PLUGINS_DIR=/path/to/build/plugins nextflow run ...
3144
```

build.gradle

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
plugins {
2+
id 'io.nextflow.nextflow-plugin' version '0.0.1-alpha4'
3+
}
4+
5+
version = '0.1.0'
6+
7+
dependencies {
8+
// add here plugins dependencies
9+
implementation 'org.json:json:20240303'
10+
implementation 'dev.harrel:json-schema:1.5.0'
11+
implementation 'com.sanctionco.jmail:jmail:1.6.3' // Needed for e-mail format validation
12+
}
13+
14+
nextflowPlugin {
15+
nextflowVersion = '24.10.0'
16+
17+
provider = 'bactopia'
18+
className = 'bactopia.plugin.BactopiaPlugin'
19+
extensionPoints = [
20+
'bactopia.plugin.BactopiaExtension',
21+
'bactopia.plugin.BactopiaFactory'
22+
]
23+
24+
publishing {
25+
registry {
26+
url = 'https://nf-plugins-registry.dev-tower.net/api'
27+
authToken = project.findProperty('pluginRegistry.accessToken')
28+
}
29+
}
30+
}

0 commit comments

Comments
 (0)