pgrouting 2.2.2 Release process checklist - pgRouting/pgrouting GitHub Wiki

Micro release is due to a critical bug.

1. Information

Branch: hotFix/issue552 Commit: bef907e3

Issue Status Comment
#552 FIXED Here
Tests
Travis
Jenkins

1. Merge code changes into develop

Develop has next minor, so only copy source code modifications

git checkout develop
git checkout hotFix/issue552 src/common/src/basePath_SSEC.hpp
git checkout hotFix/issue552

2. Version Changes

task 2.1

Modifications on the branch that fixes the issue

  • Click to the link for The instructions
  • Status:
    • PENDING
    • MODIFIED
    • COMMITTED
    • PUSHED
File Status
CMakeLists.txt PUSHED
utilities-any.result PUSHED
VERSION PUSHED
NEWS PUSHED
2_2_2.rst PUSHED
changelog/index.rst PUSHED
doc/index.rst PUSHED
signatures PUSHED
README.md PUSHED

task 2.2

  • Click to the link for The instructions
  • Status:
    • PENDING
    • DONE
subtask status
Compile DONE
Run the tests DONE
Run the documentation queries DONE

Add new files, commit & push:

git add doc/src/changelog/2_2_2.rst
git add tools/sigs/pgrouting--2.2.1.sig
git commit -a -m 'Preparing release 2.2.2'

git checkout develop
cp build/lib/pgrouting--2.2.2.sig tools/sigs/
git add tools/sigs/pgrouting--2.2.2.sig
git checkout hotFix/issue552 doc/src/changelog/2_2_2.rst
git commit -a -m 'Adding hotFix/issue552 changes'

git checkout hotFix/issue552
git push

3. Merging to master

Task 3.1

Information: Fill with the new commit number & test links

Branch: hotFix/issue552 Commit: df265ff4

Tests
Travis
Jenkins

Task 3.2

After all tests passed, from the website:

  • Create a pull request
  • Merge to master
  • delete the hotFix/issue552 branch

Task 3.3

Information: Fill with the last commit number & test links

Branch: master Commit: 544044b4

Tests
Travis
Jenkins

Task 3.4

  1. step 1
vi travis

delete hotFix/issue552 from the testing branches, leave only master & develop

step 2)

The following is necessary because of the pre-commit hook

vi VERSION

change 2.2.1 to 2.2.2

4.

Regenerate the documentation.

subtask status
Compile with doc DONE
Run the tests DONE 
git commit -a -m 'Changes before tagging pgrouting-2.2.2'
git stash
git push

The stash is necessary because of the pre-commit hook

4.2 Build the final documentation

cd build
rm -rf doc
make doc
cd ..

4.3 Copy the documentation to the gh-pages

git checkout gh-pages
rm -rf 2.2/*
cp -r build/doc/html/en 2.2
git commit -a -m 'Updating to 2.2.2 documentation'
git push

CREATE THE TAG

git tag -a -m "Create the pgrouting-2.2.2 tag" pgrouting-2.2.2
git push --tags

Go to website: https://github.com/pgRouting/pgrouting/releases/tag/pgrouting-2.2.2 Edit the tag

With the release of pgRouting 2.2.2 fixes a regression bug.

 - To see the full list of changes check the list of `Git commits <https://github.com/pgRouting/pgrouting/commits>`_ on Github.
 - To see the issues closed by this release see the `Git closed issues <https://github.com/pgRouting/pgrouting/issues?q=milestone%3ARelease-2.2.2+is%3Aclosed>`_ on Github.
 - For important changes see the following release notes.

Changes for release 2.2.2
* Fixed regression error on pgr_drivingDistance
* Fixed a documentation error

Apendix

CMakeLists.txt

vi CMakeLists.txt

Change:

# PGROUTING version number.
set(PGROUTING_VERSION_MAJOR "2")
set(PGROUTING_VERSION_MINOR "2")
set(PGROUTING_VERSION_PATCH "1")

To

# PGROUTING version number.
set(PGROUTING_VERSION_MAJOR "2")
set(PGROUTING_VERSION_MINOR "2")
set(PGROUTING_VERSION_PATCH "2")
set(PGROUTING_GIT_TAG "pgrouting-2.2.2")

utilities-any.result

vi doc/test/utilities-any.result
Change to
2.2.1 2.2.2

VERSION

vi VERSION
Change To
pgrouting-2.2.1-< rest > pgrouting-2.2.2-< rest >

NEWS

vi NEWS

Add on top of the file:

Changes for 2.2.2
-------------------------------------------------------------------------------

- Fixed regression error on pgr_drivingDistance

2_2_2.rst

Create the log file for the release

vi 2_2_2.rst

Insert the following:

..
   ****************************************************************************
    pgRouting Manual
    Copyright(c) pgRouting Contributors

    This documentation is licensed under a Creative Commons Attribution-Share
    Alike 3.0 License: http://creativecommons.org/licenses/by-sa/3.0/
   ****************************************************************************

.. _changelog_2_2_2:

pgRouting 2.2.2 Release Notes
===============================================================================

With the release of pgRouting 2.2.2 fixes a regression bug.

 - To see the full list of changes check the list of `Git commits <https://github.com/pgRouting/pgrouting/commits>`_ on Github.
 - To see the issues closed by this release see the `Git closed issues <https://github.com/pgRouting/pgrouting/issues?q=milestone%3ARelease-2.2.2+is%3Aclosed>`_ on Github.
 - For important changes see the following release notes.


Release Notes
-------------------------------------------------------------------------------


Changes for release 2.2.2

* Fixed regression error on pgr_drivingDistance

changelog/index.rst

Modify the change log on Change log file

vi doc/src/changelog/index.rst

Insert on top of the list.

   - :ref:`changelog_2_2_2`

Insert on top of the hidden tag

   2_2_2

doc/index.rst

Modify the change log on main page of documentation

vi doc/index.rst
\change_log

Insert on top of the list.

   - :ref:`changelog_2_2_2`

Signatures

We are not allowing signature changes in micro releases, for upgrading from 2.2.1 create the signature file

cp tools/sigs/pgrouting--2.2.0.sig tools/sigs/pgrouting--2.2.1.sig

On the first line:

Change to
#VERSION pgrouting 2.2.0 #VERSION pgrouting 2.2.1

README.md

vi README.md

Change:

The *master* branch reflects the current 2.2.1 release.

to

The *master* branch reflects the current 2.2.2 release.

go back to Task-2.1 before continuing

Compile

cd build/
rm -rf *
cmake ..
make
sudo make install

Run the tests

From previous command we are in build

cd ..
tools/testers/algorithm-tester.pl
createdb  ___pgr___test___
sh ./tools/testers/pg_prove_tests.sh vicky
dropdb  ___pgr___test___

createdb  ___test_update
psql  ___test_update  <<EOF
create extension postgis;
create extension pgrouting with version '2.2.0';
select pgr_version();
alter extension pgrouting update to '2.2.2';
select pgr_version();
EOF
dropdb   ___test_update

createdb  ___test_update
psql  ___test_update  <<EOF
create extension postgis;
create extension pgrouting with version '2.2.1';
select pgr_version();
alter extension pgrouting update to '2.2.2';
select pgr_version();
EOF
dropdb   ___test_update

Run the documentation queries

tools/testers/algorithm-tester.pl -documentation

go back to Task-2.2 before continuing

Compile with doc

cd build/
rm -rf *
cmake -DWITH_DOC=ON ..
make
sudo make install
make doc

Contact: https://discourse.osgeo.org/c/pgrouting/pgrouting-dev

⚠️ **GitHub.com Fallback** ⚠️