Skip to content

Commit b215b8c

Browse files
committed
Add contributing and packaging instructions
1 parent cc066a8 commit b215b8c

File tree

1 file changed

+63
-0
lines changed

1 file changed

+63
-0
lines changed

CONTRIBUTING.md

+63
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
Development And Contributing Instructions
2+
=========================================
3+
4+
Making a new release
5+
--------------------
6+
7+
To create a new release, clone the [scijava-scripts][gh_scijava-scripts] repo
8+
(e.g. in `/opt/imagej/`) and run the `release-version.sh` helper:
9+
10+
```bash
11+
BASE_DIR=/opt/imagej
12+
mkdir -pv "$BASE_DIR"
13+
cd "$BASE_DIR"
14+
git clone https://github.com/scijava/scijava-scripts
15+
cd -
16+
17+
RELEASE_SCRIPT="$BASE_DIR/scijava-scripts/release-version.sh"
18+
19+
$RELEASE_SCRIPT --skip-push --skip-gpg --skip-license-update
20+
```
21+
22+
Build & Deploy using Visual Studio Code
23+
---------------------------------------
24+
25+
Building and deploying the package can be greatly simplified using "tasks" in
26+
[Visual Studio Code][www_vscode]. By adding the following settings to the
27+
`.vscode/tasks.json` file, you can simply press `Ctrl+Shift+B` in VS Code and
28+
select the *deploy* task for running Maven and have the resulting JAR file being
29+
placed in `/opt/fiji-packaging/Fiji.app/jars/` (adjust to your path as
30+
necessary):
31+
32+
```json
33+
{
34+
"version": "2.0.0",
35+
"tasks": [
36+
{
37+
"label": "verify",
38+
"type": "shell",
39+
"command": "mvn -B verify",
40+
"group": "build"
41+
},
42+
{
43+
"label": "test",
44+
"type": "shell",
45+
"command": "mvn -B test",
46+
"group": "test"
47+
},
48+
{
49+
"label": "deploy",
50+
"type": "shell",
51+
"command": "mvn -Dimagej.app.directory=/opt/fiji-packaging/Fiji.app",
52+
"group": {
53+
"kind": "build",
54+
"isDefault": true
55+
},
56+
"problemMatcher": []
57+
}
58+
]
59+
}
60+
```
61+
62+
[gh_scijava-scripts]: https://github.com/scijava/scijava-scripts
63+
[www_vscode]: https://code.visualstudio.com/

0 commit comments

Comments
 (0)