From c0fa4ea9c558e743a5bc12b8c5b50ed5c8679fb4 Mon Sep 17 00:00:00 2001 From: Maxime Schoemans Date: Thu, 25 Apr 2024 17:07:40 +0200 Subject: [PATCH] Update actions and readme following develop branch removal (#482) --- .github/workflows/check-code.yml | 4 +-- .github/workflows/codeql.yml | 2 ++ .github/workflows/docker-image.yaml | 27 +++++++++++++-- .github/workflows/generate_dev_docs.yml | 1 - .github/workflows/generate_docs.yml | 8 ----- README.md | 45 +++++++++---------------- 6 files changed, 43 insertions(+), 44 deletions(-) diff --git a/.github/workflows/check-code.yml b/.github/workflows/check-code.yml index a3933be7d8..765d6a36f2 100644 --- a/.github/workflows/check-code.yml +++ b/.github/workflows/check-code.yml @@ -11,9 +11,7 @@ on: - 'mobilitydb/**' - 'postgis/**' - 'LICENSE.txt' - branch: - - master - - develop + branch_ignore: gh-pages jobs: license_check: diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml index 4a0cdbd948..7387305b30 100644 --- a/.github/workflows/codeql.yml +++ b/.github/workflows/codeql.yml @@ -2,7 +2,9 @@ name: "CodeQL" on: push: + branch_ignore: gh-pages pull_request: + branch_ignore: gh-pages concurrency: group: ${{ github.workflow }}-${{ github.head_ref || github.ref }} diff --git a/.github/workflows/docker-image.yaml b/.github/workflows/docker-image.yaml index c047ea8368..1c4a5a1de1 100644 --- a/.github/workflows/docker-image.yaml +++ b/.github/workflows/docker-image.yaml @@ -2,7 +2,7 @@ name: Docker image on: push: branches: - - 'develop' + - 'master' tags: - 'v[0-9]+.[0-9]+.[0-9]+' @@ -24,6 +24,29 @@ jobs: - name: Checkout uses: actions/checkout@v4.0.0 + - name: Extract highest version + id: extract-highest-version + if: ${{ matrix.psql == '16' && github.ref_type == 'tag' }} + run: | + # List tags and store the result in a variable + TAGS=$(git ls-remote --tags origin) + + # Extract major.minor version numbers from tags and store them in an array + VERSIONS=() + while read -r line; do + tag=$(echo "$line" | cut -d"/" -f3) + version=$(echo "$tag" | cut -d"v" -f2) + major=$(echo "$version" | cut -d"." -f1) + minor=$(echo "$version" | cut -d"." -f2) + VERSIONS+=("$major.$minor") + done <<< "$TAGS" + + # Sort the array to find the highest version + IFS=$'\n' sorted=($(sort -rV <<<"${VERSIONS[*]}")) + + # Output the highest version + echo "highest-version=v${sorted[0]}" >> "$GITHUB_OUTPUT" + - name: Docker meta id: meta uses: docker/metadata-action@v5 @@ -32,7 +55,7 @@ jobs: images: mobilitydb/mobilitydb # generate Docker tags based on the following events/attributes flavor: | - latest=${{ matrix.psql == '16' && github.ref_type == 'tag' }} + latest=${{ matrix.psql == '16' && github.ref_type == 'tag' && contains(github.ref_name, steps.extract-highest-version.outputs.highest-version}} prefix=${{ matrix.psql }}-${{ matrix.postgis }}- tags: | type=ref,event=branch diff --git a/.github/workflows/generate_dev_docs.yml b/.github/workflows/generate_dev_docs.yml index 7ddc05b58a..7c1109b6aa 100644 --- a/.github/workflows/generate_dev_docs.yml +++ b/.github/workflows/generate_dev_docs.yml @@ -11,7 +11,6 @@ on: - './doxygen/**' branches: - master - - develop jobs: build: diff --git a/.github/workflows/generate_docs.yml b/.github/workflows/generate_docs.yml index 359082909e..182ea64158 100644 --- a/.github/workflows/generate_docs.yml +++ b/.github/workflows/generate_docs.yml @@ -10,7 +10,6 @@ on: - 'doc/**' branches: - master - - develop jobs: build: @@ -90,13 +89,6 @@ jobs: rm -rf master mv docs-temp master - # Rename the directory to develop - - name: Rename the directory to develop - if: ${{ github.ref == 'refs/heads/develop' }} - run: | - rm -rf develop - mv docs-temp develop - # add, commit and push to gh-pages - name: Commit changes uses: EndBug/add-and-commit@v9 diff --git a/README.md b/README.md index 9f923da00a..4fc8383c91 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ ![Build Status](https://github.com/MobilityDB/MobilityDB/actions/workflows/pgversion.yml/badge.svg) -[![Coverage Status](https://coveralls.io/repos/github/MobilityDB/MobilityDB/badge.svg?branch=develop)](https://coveralls.io/github/MobilityDB/MobilityDB?branch=develop) +[![Coverage Status](https://coveralls.io/repos/github/MobilityDB/MobilityDB/badge.svg?branch=master)](https://coveralls.io/github/MobilityDB/MobilityDB?branch=master) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/833ae1093bab48cda7450e2eea456084)](https://www.codacy.com/gh/MobilityDB/MobilityDB?utm_source=github.com&utm_medium=referral&utm_content=MobilityDB/MobilityDB&utm_campaign=Badge_Grade) [![Gitter](https://badges.gitter.im/MobilityDBProject/MobilityDB.svg)](https://gitter.im/MobilityDBProject/MobilityDB?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) @@ -19,6 +19,13 @@ The MobilityDB project is managed by a [steering committee](https://github.com/M More information about MobilityDB, including publications, presentations, etc., can be found in the MobilityDB [website](https://mobilitydb.com). +Documentation +-------- + +The pregenerated user and developer documentation can be found [here](https://mobilitydb.github.io/MobilityDB/). + +To generate the documentation locally, refer to our [documentation generation section](#generating-the-documentation) + Benefits -------- @@ -84,15 +91,10 @@ For general questions and topics about how to use MobilityDB, please write to th Branches -------- -* The `master` branch has the latest release -* The `develop` branch has the development of the next release. The complete list of releases is available [here](https://github.com/MobilityDB/MobilityDB/releases) +* The `master` branch has the development of the next release. +* The `stable-major.minor` branches have the patch releases of the correspong `major.minor` release. -Status ------- - -The current pre-release version is 1.1. We plan to release 1.1 when the currently ongoing packaging for Debian and YUM is finished. For more information, please refer to the mailing lists [pgsql-pkg-debian](https://www.postgresql.org/list/pgsql-pkg-debian/) and [pgsql-pkg-yum](https://www.postgresql.org/list/pgsql-pkg-yum/). - -MobilityDB is part of the PostGIS bundle for Windows. +The complete list of releases is available [here](https://github.com/MobilityDB/MobilityDB/releases) Requirements ------------ @@ -124,10 +126,7 @@ cmake .. make sudo make install ``` -The above commands install the `master` branch. If you want to install another branch, for example, `develop`, you can replace the first command above as follows -```bash -git clone --branch develop https://github.com/MobilityDB/MobilityDB -``` + You should also set the following in `postgresql.conf` depending on the version of PostGIS you have installed (below we use PostGIS 3): ```bash shared_preload_libraries = 'postgis-3' @@ -180,9 +179,11 @@ Issues Please report any [issues](https://github.com/MobilityDB/MobilityDB/issues) you may have. -Documentation +Generating the Documentation ------------- +Pregenerated versions of the user and developer documentation can be found [here](https://mobilitydb.github.io/MobilityDB/). + ### User's Manual You can generate the user's manual in HTML, PDF, and EPUB formats. The manual is generated in English and in other available languages (currently only Spanish). For this, it is necessary to specify appropriate options in the `cmake` command as follows: @@ -206,18 +207,6 @@ make doc ``` The resulting documentation will be generated in the `doc` directory of the build directory. -In addition, pregenerated versions are available for the master and develop branches. - -* HTML: [master](https://mobilitydb.github.io/MobilityDB/master/), [develop](https://mobilitydb.github.io/MobilityDB/develop/) -* PDF: [master](https://mobilitydb.github.io/MobilityDB/master/mobilitydb-manual.pdf), [develop](https://mobilitydb.github.io/MobilityDB/develop/mobilitydb-manual.pdf) -* EPUB: [master](https://mobilitydb.github.io/MobilityDB/master/mobilitydb-manual.epub), [develop](https://mobilitydb.github.io/MobilityDB/develop/mobilitydb-manual.epub) - -The documentation is also avaible in Spanish. - -* HTML: [master](https://mobilitydb.github.io/MobilityDB/master/es/), [develop](https://mobilitydb.github.io/MobilityDB/develop/es/) -* PDF: [master](https://mobilitydb.github.io/MobilityDB/master/es/mobilitydb-manual.pdf), [develop](https://mobilitydb.github.io/MobilityDB/develop/es/mobilitydb-manual.pdf) -* EPUB: [master](https://mobilitydb.github.io/MobilityDB/master/es/mobilitydb-manual.epub), [develop](https://mobilitydb.github.io/MobilityDB/develop/es/mobilitydb-manual.epub) - ### Developer's Documentation You can generate the English developer's documentation in HTML format. For this, it is necessary to the option `DOC_DEV` in the `cmake` command as follows: @@ -229,10 +218,6 @@ make doc_dev The resulting HTML documentation will be generated in the `doxygen` directory of the build directory. -In addition, pregenerated versions are available for the master and develop branches. - -* HTML: [master](https://mobilitydb.github.io/MobilityDB/master-dev/), [develop](https://mobilitydb.github.io/MobilityDB/develop-dev/) - Licenses --------