The Data Conservancy Packaging Tool
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
dcs-packaging-tool-api
dcs-packaging-tool-assemblies
dcs-packaging-tool-cli
dcs-packaging-tool-gui
dcs-packaging-tool-impl
dcs-packaging-tool-integration
dcs-packaging-tool-model-builder-properties
dcs-packaging-tool-model-builder
dcs-packaging-tool-model
dcs-packaging-tool-ontologies
dcs-packaging-tool-profiles
dcs-packaging-tool-ser
dcs-packaging-tool-shared
src
.gitattributes
.gitignore
.travis.yml
README.md
pom.xml
settings.tar.enc

README.md

Data Conservancy Packaging tool

The Data Conservancy Packaging Tool is a JavaFX GUI used to describe and package digital content.

The packaging tool produces packages that are compliant with the following specifications:

Note: the Data Conservancy specifications are managed separately, here.

Full documentation is available on our wiki.

Releases

Releases are cataloged on the GitHub Releases page.

Developer Quick Start

Prerequisites

  • Oracle JDK 8 with Java FX

####To build the entire tool ####

Clone this repository.

mvn clean install

Some tests require creating symbolic links which is a privileged operation on Windows. To run all tests except those requiring escalated privileges: mvn clean install -P unprivileged

Some tests also create large, temporary, files for testing (~8 GB) which may not be accommodated by machines with limited resources. To run all tests except those requiring large amounts of resources: mvn clean install -P constrained

You can skip both kinds of tests by running: mvn clean install -Pconstrained,unprivileged

To run the package tool GUI

cd dcs-packaging-tool-gui
mvn jfx:run

Creating a release

Requirements

  • Oracle Java 8 >= 1.8.0-40
  • Maven 3.3.9 or greater

Preparation

  • Releases are cut from the master branch
  • The HEAD commit hash of master for your local git repository should match the HEAD commit hash of your https://github.com/DataConservancy/dcs-packaging-tool.git remote (named upstream, in these instructions)
    • e.g. the commit shown by git show master and git show upstream/master should be the same
  • There should be no modified, unversioned, or staged files in your local git repository (check with git status)
  • The Travis build for master should be green
  • Know what version you are releasing (e.g. 1.0.4)
  • Know what the next development version should be (e.g. 1.0.5-SNAPSHOT)
  • Note the commit hash of HEAD, useful if you need to roll back

Perform the release

  • mvn release:prepare
    • Bumps the version in the POMs to the release version (e.g. from 1.0.4-SNAPSHOT to 1.0.4)
    • Tags the release
    • Checks out the newly created tag
    • Builds the tag

At this point, you can look at your git commit log to see if everything looks ok. Nothing has been pushed yet, so if you see a mistake, it is easy to roll back. To roll back:

  • mvn release:clean
  • git reset --hard HEAD^
  • git tag -D <newly created tag> (use git tag to list the tags)

If all goes well with mvn release:prepare, then you're ready to perform the release.

  • mvn release:perform
    • Deploys release artifacts to the Maven repository
    • Bumps the version in the POMs to the next development version (e.g. from 1.0.4 to 1.0.5-SNAPSHOT)

At this point, you can still look at your git commit log to see if everything looks ok! Nothing has been pushed yet, so if you see a mistake, it is mostly easy to roll back. To roll back:

  • mvn release:clean
  • git reset --hard HEAD^^
  • git tag -D <newly created tag> (use git tag to list the tags)
  • Depending on the situation, you may need to delete deployed release artifacts from the Maven repository

If all went well with mvn release:perform, push your changes to https://github.com/DataConservancy/dcs-packaging-tool.git, making the release official. Alternately, open a PR, which will make the release official upon merging.

Finally, push the tags to https://github.com/DataConservancy/dcs-packaging-tool.git (git push --tags upstream).

Create native installers

After the release has been pushed to master, native installers for MacOS, Windows, and Linux need to be created.

They must be created from the release tag. This insures that build metadata like the commit hash, the tag, and version number of the tool are consistent across the three platforms, and of course, insures that they are all cut from identical code.

  • git checkout <tag>
MacOS

To create the MacOS native installer, cd into dcs-package-tool-gui, and run:

  • mvn clean jfx:native

The installer will be located at dcs-packaging-tool-gui/target/jfx/native/DC Package Tool-1.0.4.dmg

Linux
  • TODO
Windows
  • TODO

Create GitHub release

  • A release should be created on the GitHub releases page
  • Some release notes should be prepared, summarizing major changes
  • The native installers should be uploaded to the release page, and their checksums noted