Skip to content

Latest commit

 

History

History
151 lines (106 loc) · 4.09 KB

CONTRIBUTING.md

File metadata and controls

151 lines (106 loc) · 4.09 KB
Raw

Guidelines for developers

  1. Changes should be made in a branch and submitted via Pull Request to the master branch.
  2. Pull Requests should be reviewed and Travis and Appveyor builds must succeed before merging.
  3. Keep the CHANGELOG.md up to date.
  4. This project adheres to Semantic Versioning.

Continuous Integration Builds

Builds for Linux and Mac versions are run via Travis.

Builds for Windows are run via Appveyor.

Tagged versions are automatically released on GitHub releases.

Releases

  1. Create branch prepare_release_<version>.

  2. Update CHANGELOG.md from Unreleased to <version>, update diff links.

  3. Submit Pull Request for the prepare_release_<version> branch.

  4. Once other members agree to release, merge the PR and ensure Travis and Appveyor pass.

  5. Update local repo with the merge commit:

    git checkout master
git fetch upstream master
git merge upstream master

  6. Tag with new version:

    git tag -a <version>
git push --tags

  7. Check GitHub releases, add helpful release notes, etc.

  8. Prepare for new development (can be pushed directly to master):

    1. Update CHNAGELOG.md to add Unreleased section, add diff link: 
      [Unreleased]: https://github.com/eugenemel/maven/compare/<version>...HEAD

Compile

```
git clone --recursive  git@github.com:eugenemel/maven.git maven
cd maven
qmake -r build.pro
make -j4
```

Make distributable package

```
make INSTALL_ROOT=appdir install
make_dist_[platform].sh src/maven/appdir/bin/[executable]
```

platform is one of win32, osx, or linux

executable is the name of the executable (e.g. maven_dev_800.exe or Maven.app)

Dependencies

Windows

  1. Install the MSYS2 platform for Windows

  2. From a mingw64 prompt, install 64-bit QT, zlib, and sqlite

    ```
pacman -S --needed --noconfirm git
pacman -S --needed --noconfirm make
pacman -S --needed --noconfirm mingw-w64-x86_64-qt-creator
pacman -S --needed --noconfirm zlib-devel
pacman -S --needed --noconfirm mingw64/mingw-w64-x86_64-sqlite3
```

Note: There is a bug in MSYS2 packages that causes the following error:

```
Cloning into 'maven_core'...
warning: redirecting to https://github.com/eugenemel/maven_core/
remote: Counting objects: 694, done.
remote: Total 694 (delta 0), reused 0 (delta 0), pack-reused 694
Receiving objects: 100% (694/694), 1.53 MiB | 0 bytes/s, done.
Resolving deltas: 100% (153/153), done.
Checking out files: 100% (576/576), done.
': not a valid identifierline 88: export: `dashless
```

WORKAROUND

```
mv /mingw64/bin/envsubst.exe /mingw64/bin/envsubst.exe.orig
pacman -S gettext
```

OSX / MacOS

  1. Install the Homebrew package management system

  2. Install the qt5 package

    ```
brew update
brew install qt5
```

  3. Setup the environment for the newly installed qt5

    ```
export PATH="/usr/local/opt/qt/bin:$PATH"
export LDFLAGS="-L/usr/local/opt/qt/lib"
export CPPFLAGS="-I/usr/local/opt/qt/include"
export PKG_CONFIG_PATH="/usr/local/opt/qt/lib/pkgconfig"
```

Linux (Ubuntu 16.04 LTS, Xenial)

  1. Add the PPA to install QT 5.8

    ```
sudo add-apt-repository ppa:beineri/opt-qt58-xenial
sudo apt-get update
```

  2. Install QT, opengl libraries, sqlite3, mysql, and libssl-dev

    ```
sudo apt-get install qt58-meta-minimal \
                     mesa-common-dev \
                     libgl1-mesa-dev \
                     libsqlite3-dev \
                     libmysqlclient-dev \
                     libssl1.0.0 \
                     libssl-dev
```