Skip to content
This repository has been archived by the owner on Aug 20, 2024. It is now read-only.

Commit

Permalink
update make install to use NXF_PLUGINS_DIR. Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
awgymer committed Oct 23, 2023
1 parent 1a6bf69 commit 6e22fa1
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 26 deletions.
17 changes: 10 additions & 7 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,11 +1,14 @@

config ?= compileClasspath
version ?= $(shell grep 'Plugin-Version' plugins/nf-validation/src/resources/META-INF/MANIFEST.MF | awk '{ print $$2 }')

ifdef module
mm = :${module}:
else
mm =
endif
mm =
endif

NXF_HOME ?= $$HOME/.nextflow
NXF_PLUGINS_DIR ?= $(NXF_HOME)/plugins

clean:
./gradlew clean
Expand All @@ -14,11 +17,9 @@ compile:
./gradlew compileGroovy
@echo "DONE `date`"


check:
./gradlew check


#
# Show dependencies try `make deps config=runtime`, `make deps config=google`
#
Expand All @@ -44,15 +45,17 @@ else
./gradlew ${mm}test --tests ${class}
endif


install:
./gradlew copyPluginZip
rm -rf ${NXF_PLUGINS_DIR}/nf-validation-${version}
cp -r build/plugins/nf-validation-${version} ${NXF_PLUGINS_DIR}

#
# Upload JAR artifacts to Maven Central
#
upload:
./gradlew upload


upload-plugins:
./gradlew plugins:upload

Expand Down
26 changes: 7 additions & 19 deletions docs/contributing/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,30 +17,18 @@ To compile and run the tests use the following command:

To test with Nextflow for development purpose:

Clone the Nextflow repo into a sibling directory
Compile and install the plugin code

```bash
cd .. && git clone https://github.com/nextflow-io/nextflow
cd nextflow && ./gradlew exportClasspath
make compile
make install
```

Append to the `settings.gradle` in this project the following line:
!!! warning

```bash
includeBuild('../nextflow')
```

Compile the plugin code

```bash
./gradlew compileGroovy
```

Run nextflow with this command:

```bash
./launch.sh run -plugins nf-validation <script/pipeline name> [pipeline params]
```
This installs the compiled plugin code into your `${HOME}/.nextflow/plugins`
directory. If the manifest version of your dev code matches an existing plugin any
install will be overwritten.

## Change and preview the docs

Expand Down

0 comments on commit 6e22fa1

Please sign in to comment.