Merge pull request #484 from jacobwilliams/develop

Develop

Author: jacobwilliams

.github/CONTRIBUTING.md

@@ -72,7 +72,7 @@ git rebase upstream/master
 ```
 - Create a branch in your fork with a descriptive name that also includes the [issue number](https://github.com/jacobwilliams/json-fortran/issues), if applicable. For example, after forking the repo, you can run something like `git checkout -b Unicode-support-issue-35` before starting work on [issue #35 : Unicode support](https://github.com/jacobwilliams/json-fortran/issues/35)
 - When you're content with your changes, your commits are clean, self contained, with concise descriptive messages, and your changes compile and pass the tests, submit a pull request. We will review your changes, and may ask for certain modifications to be made.
-- Pull requests are tested by our [travis-ci](https://travis-ci.com/jacobwilliams/json-fortran) continuous integration system, and any errors uncovered will need to be fixed before the pull request can be merged into master.
+- Pull requests are tested by our [GitHub Actions](https://github.com/jacobwilliams/json-fortran/actions) continuous integration system, and any errors uncovered will need to be fixed before the pull request can be merged into master.
 - The JSON-Fortran library and associated documentation is released under a BSD style [license](https://github.com/jacobwilliams/json-fortran/blob/master/LICENSE).  By submitting a pull request, you are agreeing to release your code under the same license.  Note that code with GPL or other "copyleft" style licenses will not be accepted.
 
 [top](#contributing-to-json-fortran)

.github/workflows/CI.yml

@@ -0,0 +1,129 @@
+name: CI
+
+on: [push]
+
+jobs:
+
+  Build:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        gcc_v: [7,8,9,10] # Version of GFortran we want to use.
+        python-version: [3.7]
+    env:
+      FC: gfortran-${{matrix.gcc_v}}
+      GCC_V: ${{matrix.gcc_v}}
+
+    steps:
+
+    - name: Set vars
+      id: vars
+      run: echo ::set-output name=tag::${GITHUB_REF#refs/*/}
+
+    - name: Checkout code
+      uses: actions/checkout@v2
+      with:
+        submodules: recursive
+
+    - name: Setup cmake
+      if: contains( matrix.gcc_v, 9 )
+      uses: jwlawson/[email protected]
+      with:
+        cmake-version: '3.19.x'
+
+    - name: Install Python
+      uses: actions/setup-python@v1 # Use pip to install latest CMake, & FORD/Jin2For, etc.
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Setup Graphviz
+      uses: ts-graphviz/setup-graphviz@v1
+
+    - name: Install Python dependencies
+      if: contains( matrix.os, 'ubuntu')
+      run: |
+        python -m pip install --upgrade pip
+        pip install ford FoBiS.py pygooglechart
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+
+    - name: Install GFortran Linux
+      if: contains( matrix.os, 'ubuntu')
+      run: |
+        sudo add-apt-repository ppa:ubuntu-toolchain-r/test
+        sudo apt-get update
+        sudo apt-get install -y gcc-${GCC_V} gfortran-${GCC_V}
+        sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-${GCC_V} 100 \
+        --slave /usr/bin/gfortran gfortran /usr/bin/gfortran-${GCC_V} \
+        --slave /usr/bin/gcov gcov /usr/bin/gcov-${GCC_V}
+
+    - name: Compile_with_build
+      if: matrix.gcc_v != 7
+      run: |
+        GFORTRAN=gfortran-${{matrix.gcc_v}}
+        GCOV=gcov-${{matrix.gcc_v}}
+        # build with build.sh, run unit tests
+        ./build.sh --skip-documentation
+        ./build.sh --skip-documentation --enable-unicode
+
+    - name: Compile_with_cmake
+      # CMake build with unit tests, no documentation, with coverage analysis
+      # No unicode so that coverage combined with the build script will cover unicode
+      # and non-unicode code paths
+      if: matrix.gcc_v == 9
+      run: |
+        GFORTRAN=gfortran-${{matrix.gcc_v}}
+        GCOV=gcov-${{matrix.gcc_v}}
+        mkdir cmake-build
+        cd cmake-build
+        cmake ..
+        make -j 4 check
+
+    - name: Compile_with_build_mkdocs
+      # build with build.sh, make documentation, run unit tests
+      # and perform coverage analysis - used for doc deployment
+      if: matrix.gcc_v == 7
+      run: |
+        GFORTRAN=gfortran-${{matrix.gcc_v}}
+        GCOV=gcov-${{matrix.gcc_v}}
+        ./build.sh --coverage --skip-documentation
+        ./build.sh --coverage --enable-unicode
+
+    - name: Deploy Documentation for master
+      if: matrix.gcc_v == 7 && github.ref == 'refs/heads/master'
+      uses: JamesIves/[email protected]
+      with:
+        branch: gh-pages # The branch the action should deploy to.
+        folder: doc  # The folder the action should deploy.
+        clean: true
+        clean-exclude: |
+          prev
+
+    - name: Rebuild documentation for tagged release
+      env:
+        TAGNAME: ${{ steps.vars.outputs.tag }}
+      if: matrix.gcc_v == 7 && startsWith(github.ref, 'refs/tags/')
+      run: |
+        echo ${TAGNAME}
+        rm -rf doc
+        sed "2 s/^/version: ${TAGNAME}\n/" json-fortran.md > json-fortran.tagged.md
+        ford --debug json-fortran.tagged.md
+
+    - name: Deploy documentation for tagged release
+      env:
+        TAGNAME: ${{ steps.vars.outputs.tag }}
+      if: matrix.gcc_v == 7 && startsWith(github.ref, 'refs/tags/')
+      uses: JamesIves/[email protected]
+      with:
+        branch: gh-pages # The branch the action should deploy to.
+        folder: doc  # The folder the action should deploy.
+        target-folder: prev/$TAGNAME  # deploy to a version-specific folder
+
+    - name: Upload coverage
+      if: matrix.gcc_v == 7
+      run: |
+        rm json_*.F90-*unicode.gcov || true
+        mv json_*.F90.gcov src/
+        mv jf_test*.[fF]90.gcov src/tests/
+        bash <(curl -s https://codecov.io/bash) -v -X $GCOV

.gitignore

@@ -34,4 +34,7 @@ My Amplifier*
 My Inspector*
 x64/
 Debug/
-Release/
+Release/
+
+# mac
+.DS_Store

.travis.yml renamed to .travis-old/.travis.yml

@@ -0,0 +1,37 @@
+#!/bin/bash
+# Script to deploy documentation after successful build of master branch or tag
+# If running under travis-ci this will automatically deploy updates to the master branch's
+# documentation on build events for the master branch, and will add/update documentation for
+# any new/updated tags that are pushed.
+set -o errexit
+set -o verbose
+if [ "$TRAVIS" ]; then #running under travis
+    if $TRAVIS_SECURE_ENV_VARS ; then
+    # only try to update master's development documentation
+    if [ "$TRAVIS_BRANCH" = "master" ] && \
+           [ "$TRAVIS_PULL_REQUEST" = "false" ] && \
+           [ "$(ls -A "$TRAVIS_BUILD_DIR/doc")" ] ; then #not empty
+            git clone -q --branch=gh-pages "https://${GH_TOKEN}@github.com/$TRAVIS_REPO_SLUG" gh-pages >/dev/null 2>&1
+            cd gh-pages || exit 1
+        rm -rf -- css fonts graphs interface lists module proc search.html src type favicon.png index.html \
+           js media page program sourcefile tipuesearch || true
+        cp -r "$TRAVIS_BUILD_DIR"/doc/* .
+            git add -A || true # Add all the new files
+            git commit -m "Development documentation updated by travis job $TRAVIS_JOB_NUMBER for commits $TRAVIS_COMMIT_RANGE" || true
+            git push -fq origin gh-pages > /dev/null 2>&1 || true
+    fi
+    # If publishing a new/updated tag, deploy its documentation
+    if [ "$TRAVIS_TAG" ] && [ "$(ls -A "$TRAVIS_BUILD_DIR/doc")" ] ; then #not empty
+        cd "$TRAVIS_BUILD_DIR" || exit 1
+        git clone -q --branch=gh-pages "https://${GH_TOKEN}@github.com/$TRAVIS_REPO_SLUG" gh-pages >/dev/null 2>&1
+        sed "2 s/^/version: ${TRAVIS_TAG}\n/" json-fortran.md > json-fortran.tagged.md
+        head json-fortran.tagged.md # Debug output
+        # rebuild FORD documentation without pages, with version info, wiping out any existing tag folder
+        ford --debug -o "gh-pages/$TRAVIS_TAG" json-fortran.tagged.md
+        cd gh-pages || exit 1
+        git add -A # add all new files in $TRAVIS_TAG/
+        git commit -m "Tag/release documentation updated by travis job $TRAVIS_JOB_NUMBER for tag $TRAVIS_TAG $TRAVIS_COMMIT"
+        git push -f -q origin gh-pages >/dev/null 2>&1
+    fi
+    fi
+fi

.travis-old/deploy.sh

@@ -267,7 +267,7 @@ if ( NOT SKIP_DOC_GEN )
     endif ()
   else () # Not found
     message ( WARNING
-      "FORD not found! Please set the CMake cache variable FORD to point to the installed FORD executable, and reconfigure or disable building the documentation. FORD can be installed from PYPI with `sudo pip install FORD` or from <https://github.com/cmacmackin/ford> If you do not wish to install FORD and build the JSON-Fortran documentation, then please set the CMake cache variable SKIP_DOC_GEN to TRUE." )
+      "FORD not found! Please set the CMake cache variable FORD to point to the installed FORD executable, and reconfigure or disable building the documentation. FORD can be installed from PYPI with `pip install ford` or from <https://github.com/Fortran-FOSS-Programmers/ford> If you do not wish to install FORD and build the JSON-Fortran documentation, then please set the CMake cache variable SKIP_DOC_GEN to TRUE." )
   endif ()
 endif ()
 

CMakeLists.txt

@@ -1,7 +1,7 @@
 JSON-Fortran: A Fortran 2008 JSON API
 <https://github.com/jacobwilliams/json-fortran>
 
-Copyright (c) 2014-2020, Jacob Williams
+Copyright (c) 2014-2021, Jacob Williams
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification,

LICENSE

@@ -21,7 +21,7 @@ A Fortran 2008 JSON API
 
 Status
 ------
-[![Build Status](https://img.shields.io/travis/jacobwilliams/json-fortran/master.svg?style=plastic)](https://travis-ci.com/github/jacobwilliams/json-fortran)
+![Build Status](https://github.com/jacobwilliams/json-fortran/actions/workflows/CI.yml/badge.svg)
 [![GitHub issues](https://img.shields.io/github/issues/jacobwilliams/json-fortran.png?style=plastic)](https://github.com/jacobwilliams/json-fortran/issues)
 [![Codecov](https://codecov.io/gh/jacobwilliams/json-fortran/branch/master/graph/badge.svg)](https://codecov.io/gh/jacobwilliams/json-fortran)
 
@@ -168,7 +168,6 @@ Miscellaneous
 
 * JSON-Fortran is a fork and extensive upgrade of the Fortran 95 [FSON](https://github.com/josephalevin/fson) code. The reason for the split was to be able to incorporate object-oriented and other nice features of the Fortran 2003 and 2008 standards.  Many thanks to the original authors of FSON.
 * For more information about JSON, see: <http://www.json.org/>
-* [json-fortran on Travis CI](https://travis-ci.com/jacobwilliams/json-fortran)
 * [json-fortran on Codecov.IO](https://codecov.io/gh/jacobwilliams/json-fortran)
 
 [top](#json-fortran)

README.md

@@ -390,7 +390,7 @@ if [[ $JF_SKIP_DOCS != [yY]* ]]; then
     echo "$FPP" > .PREPROCESSOR # Override via include in project file, until FORD gets CLI for this
     ford --debug "${MACRO_FLAG[@]}" -p "$PAGESDIR" "$FORDMD"
     else
-    echo "FORD not found! Install using: sudo pip install ford"
+    echo "FORD not found! Install using: pip install ford"
     fi
 else
     echo "Skip building documentation since \$JF_SKIP_DOCS has been set to ${JF_SKIP_DOCS}."