Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
P
python-imcflibs
Manage
Activity
Members
Labels
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
This is an archived project. Repository and other project resources are read-only.
Show more breadcrumbs
imcf
python-imcflibs
Commits
d39a81cc
Commit
d39a81cc
authored
4 years ago
by
Niko Ehrenfeuchter
Browse files
Options
Downloads
Patches
Plain Diff
Add contributing and packaging instructions
parent
f4f3a03b
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
CONTRIBUTING.md
+68
-0
68 additions, 0 deletions
CONTRIBUTING.md
with
68 additions
and
0 deletions
CONTRIBUTING.md
0 → 100644
+
68
−
0
View file @
d39a81cc
Development And Contributing Instructions
=========================================
Creating a Python package
-------------------------
:memo: TODO: add instructions for packaging for plain Python!
Making a new release via Maven
------------------------------
To create a new release, clone the
[
scijava-scripts
][
gh_scijava-scripts
]
repo
(e.g. in
`/opt/imagej/`
) and run the
`release-version.sh`
helper:
```
bash
BASE_DIR
=
/opt/imagej
mkdir
-pv
"
$BASE_DIR
"
cd
"
$BASE_DIR
"
git clone https://github.com/scijava/scijava-scripts
cd
-
RELEASE_SCRIPT
=
"
$BASE_DIR
/scijava-scripts/release-version.sh"
$RELEASE_SCRIPT
--skip-push
--skip-gpg
--skip-license-update
```
Build & Deploy with Maven using Visual Studio Code
--------------------------------------------------
Building and deploying the package can be greatly simplified using "tasks" in
[
Visual Studio Code
][
www_vscode
]
. By adding the following settings to the
`.vscode/tasks.json`
file, you can simply press
`Ctrl+Shift+B`
in VS Code and
select the
*deploy*
task for running Maven and have the resulting JAR file being
placed in
`/opt/fiji-packaging/Fiji.app/jars/`
(adjust to your path as
necessary):
```
json
{
"version"
:
"2.0.0"
,
"tasks"
:
[
{
"label"
:
"verify"
,
"type"
:
"shell"
,
"command"
:
"mvn -B verify"
,
"group"
:
"build"
},
{
"label"
:
"test"
,
"type"
:
"shell"
,
"command"
:
"mvn -B test"
,
"group"
:
"test"
},
{
"label"
:
"deploy"
,
"type"
:
"shell"
,
"command"
:
"mvn -Dimagej.app.directory=/opt/fiji-packaging/Fiji.app"
,
"group"
:
{
"kind"
:
"build"
,
"isDefault"
:
true
},
"problemMatcher"
:
[]
}
]
}
```
[
gh_scijava-scripts
]:
https://github.com/scijava/scijava-scripts
[
www_vscode
]:
https://code.visualstudio.com/
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment