Skip to content

Commit ee4f77f

Browse files
committed
Move dev instructions to CONTRIBUTING.md
1 parent 64fc695 commit ee4f77f

File tree

2 files changed

+42
-39
lines changed

2 files changed

+42
-39
lines changed

CONTRIBUTING.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# nf-prov
2+
3+
Contributions are welcome. Fork [this repository](https://github.com/nextflow-io/nf-prov) and open a pull request to propose changes. Consider submitting an [issue](https://github.com/nextflow-io/nf-prov/issues/new) to discuss any proposed changes with the maintainers before submitting a pull request.
4+
5+
## Development
6+
7+
Build and install the plugin to your local Nextflow installation:
8+
9+
```bash
10+
make install
11+
```
12+
13+
Run with Nextflow as usual:
14+
15+
```bash
16+
nextflow run nf-prov-test -plugins nf-prov@<version>
17+
```
18+
19+
## Publishing
20+
21+
Follow these steps to package, upload, and publish the plugin:
22+
23+
1. In `build.gradle` make sure that:
24+
* `version` matches the desired release version,
25+
* `github.repository` matches the repository of the plugin,
26+
* `github.indexUrl` points to your fork of the plugins index repository.
27+
28+
2. Create a file named `$HOME/.gradle/gradle.properties`, where `$HOME` is your home directory. Add the following properties:
29+
30+
* `github_username`: The GitHub username granting access to the plugin repository.
31+
* `github_access_token`: The GitHub access token required to upload and commit changes to the plugin repository.
32+
* `github_commit_email`: The email address associated with your GitHub account.
33+
34+
3. Update the [changelog](./CHANGELOG.md).
35+
36+
4. Build and publish the plugin to your GitHub repository:
37+
38+
```bash
39+
make release
40+
```
41+
42+
5. Create a pull request against the [nextflow-io/plugins](https://github.com/nextflow-io/plugins/blob/main/plugins.json) repository to make the plugin publicly accessible.

README.md

Lines changed: 0 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -70,42 +70,3 @@ See the [nf-prov-test](./nf-prov-test) directory for an example pipeline that pr
7070
`prov.patterns`
7171

7272
List of file patterns to include in the provenance report, from the set of published files. By default, all published files are included.
73-
74-
## Development
75-
76-
Build and install the plugin to your local Nextflow installation:
77-
78-
```bash
79-
make install
80-
```
81-
82-
Run with Nextflow as usual:
83-
84-
```bash
85-
nextflow run nf-prov-test -plugins nf-prov@<version>
86-
```
87-
88-
## Package, Upload, and Publish
89-
90-
Following these step to package, upload and publish the plugin:
91-
92-
1. In `build.gradle` make sure that:
93-
* `version` matches the desired release version,
94-
* `github.repository` matches the repository of the plugin,
95-
* `github.indexUrl` points to your fork of the plugins index repository.
96-
97-
2. Create a file named `$HOME/.gradle/gradle.properties`, where `$HOME` is your home directory. Add the following properties:
98-
99-
* `github_username`: The GitHub username granting access to the plugin repository.
100-
* `github_access_token`: The GitHub access token required to upload and commit changes to the plugin repository.
101-
* `github_commit_email`: The email address associated with your GitHub account.
102-
103-
3. Update the [changelog](./CHANGELOG.md).
104-
105-
4. Build and publish the plugin to your GitHub repository:
106-
107-
```bash
108-
make release
109-
```
110-
111-
5. Create a pull request against the [nextflow-io/plugins](https://github.com/nextflow-io/plugins/blob/main/plugins.json) repository to make the plugin publicly accessible.

0 commit comments

Comments
 (0)