Skip to content

Commit

Permalink
Merge pull request #4864 from aurianer/release_notes_1_5_0
Browse files Browse the repository at this point in the history
Release notes 1.5.0 and small fixes to the release scripts
  • Loading branch information
aurianer authored Aug 14, 2020
2 parents 2145d63 + a902f0a commit a78ab52
Show file tree
Hide file tree
Showing 53 changed files with 809 additions and 325 deletions.
2 changes: 1 addition & 1 deletion .github/SUPPORT.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ get support for using HPX.
to get in contact with us as most of the developers are available on this
channel. Check out the [channel archives](http://irclog.cct.lsu.edu/ste~b~~b~ar)
for past conversations.
* #hpx on [matrix.org](https://riot.im/app/#/room/#hpx:matrix.org): this channel
* #hpx on [matrix.org](https://matrix.to/#/#hpx:matrix.org): this channel
is bridged to the IRC channel.
* Slack ([registration](https://cpplang.now.sh/)): The
[`#hpx`](https://cpplang.slack.com/messages/C68QLPZB3) channel is another
Expand Down
4 changes: 4 additions & 0 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -985,10 +985,14 @@ hpx_option(
# ##############################################################################
# enable OpenMP emulation
# ##############################################################################
# Deprecated in 1.5.0
hpx_option(
HPX_WITH_HPXMP BOOL "Enable hpxMP OpenMP emulation." OFF CATEGORY "OpenMP"
)
if(HPX_WITH_HPXMP)
hpx_warn(
"HPXMP support is deprecated. This option will be removed in a future release."
)
if(NOT MSVC AND (("${CMAKE_CXX_COMPILER_ID}" STREQUAL "Clang")
OR ("${CMAKE_CXX_COMPILER_ID}" STREQUAL "GNU"))
)
Expand Down
4 changes: 3 additions & 1 deletion docs/sphinx/about_hpx/people.rst
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,8 @@ Acknowledgements
Thanks also to the following people who contributed directly or indirectly to
the project through discussions, pull requests, documentation patches, etc.

* Giannis Gonidelis, for his work on the ranges adaptation during the
Google Summer of Code 2020.
* Auriane Reverdell (|cscs|_), for her tireless work on refactoring our CMake
setup and modularizing |hpx|.
* Christopher Hinz, for his work on refactoring our CMake setup.
Expand Down Expand Up @@ -252,7 +254,7 @@ the project through discussions, pull requests, documentation patches, etc.
xaguilar, Andrew Kemp, Dylan Stark, Matthew Anderson, Jeremy Wilke, Jiazheng
Yuan, CyberDrudge, david8dixon, Maxwell Reeser, Raffaele Solca, Marco
Ippolito, Jules Penuchot, Weile Wei, Severin Strobl, Kor de Jong, albestro,
Jeff Trull, and Yuri Victorovich who contributed to the general
Jeff Trull, Yuri Victorovich, and Gregor Daiß who contributed to the general
improvement of |hpx|.

In addition to the people who worked directly with |hpx| development we would
Expand Down
65 changes: 23 additions & 42 deletions docs/sphinx/contributing/release_procedure.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,17 +21,6 @@ are completed to avoid confusion.

#. Notify developers that a release is imminent.

#. Make a list of examples and benchmarks that should not go into the release.
Build all examples and benchmarks that will go in the release and make sure
they build and run as expected.

* Make sure all examples and benchmarks have example input files, and usage
documentation, either in the form of comments or a readme.

#. Send the list of examples and benchmarks that will be included in the release
to [email protected] and [email protected], and ask for
feedback. Update the list as necessary.

#. Write release notes in ``docs/sphinx/releases/whats_new_$VERSION.rst``. Keep
adding merged PRs and closed issues to this until just before the release is
made. Use ``tools/generate_pr_issue_list.sh`` to generate the lists. Add the
Expand All @@ -50,34 +39,32 @@ are completed to avoid confusion.
* Update collaborators
* Update grant information

#. This step does not apply to patch releases. For both APEX and hpxMP:
#. This step does not apply to patch releases. For both APEX and libCDS:

* Change the release branch to be the most current release tag available in
the APEX/hpxMP ``git_external`` section in the main ``CMakeLists.txt``.
the APEX/libCDS ``git_external`` section in the main ``CMakeLists.txt``.
Please contact the maintainers of the respective packages to generate a new
release to synchronize with the |hpx| release (`APEX
<http://github.com/khuck/xpress-apex>`_, `hpxMP
<https://github.com/STEllAR-GROUP/hpxMP>`_).
<http://github.com/khuck/xpress-apex>`_, `libCDS
<https://github.com/STEllAR-GROUP/libcds>`_).

#. If there have been any commits to the release branch since the last release,
create a tag from the old release branch before deleting the old release
branch in the next step.

#. Unprotect the release branch in the github repository settings so that it can
be deleted and recreated.
be deleted and recreated (tick "Allow force pushes" in the release branch
settings of the repository).

#. Delete the old release branch, and create a new one by branching a stable
point from master. If you are creating a patch release, branch from the
#. Reset the release branch to the latest stable state on master and force push
to origin/release. If you are creating a patch release, branch from the
release tag for which you want to create a patch release.

* ``git push origin --delete release``
* ``git branch -D release``
* ``git checkout [stable point in master]``
* ``git branch release``
* ``git push origin release``
* ``git branch --set-upstream-to=origin/release release``
* ``git checkout -b release`` (or just ``checkout`` in case the it exists)
* ``git reset --hard stable``
* ``git push --force origin release``

#. Protect the release branch again to disable deleting and force pushes.
#. Protect the release branch again to disable force pushes.

#. Check out the release branch.

Expand All @@ -99,23 +86,23 @@ are completed to avoid confusion.

The main CMakeLists.txt contains a comment indicating for which version
the breaking change was introduced first.
In the case of deprecated features which don't have a replacement yet, we
keep them around in case (like Vc for example).

#. Update the minimum required versions if necessary (compilers, dependencies,
etc.).

#. Switch Buildbot over to test the release branch.
etc.) in ``building_hpx.rst``.

* ``https://github.com/STEllAR-GROUP/hermione-buildbot/blob/rostam/master/master.cfg``
* ``branch`` field in ``c['change_source'] = GitPoller``
#. Verify that the jenkins setup for the release branch on rostam is running
and does not display any errors.

#. Repeat the following steps until satisfied with the release.

#. Change ``HPX_VERSION_TAG`` in ``CMakeLists.txt`` to ``-rcN``, where ``N``
is the current iteration of this step. Start with ``-rc1``.

#. Tag and create a pre-release on GitHub using the script
``tools/roll_release.sh``. The script requires that you have the |stellar|
Group signing key.
#. Create a pre-release on GitHub using the script ``tools/roll_release.sh``.
This script automatically tag with the corresponding release number.
The script requires that you have the |stellar| Group signing key.

#. This step is not necessary for patch releases. Notify
``[email protected]`` and ``[email protected]`` of the
Expand Down Expand Up @@ -144,9 +131,9 @@ are completed to avoid confusion.
the docs, and change the value of ``HPX_VERSION_DATE`` in
``CMakeLists.txt``.

#. Tag and create a release on GitHub using the script
``tools/roll_release.sh``. The script requires that you have the |stellar|
Group signing key.
#. Create a release on GitHub using the script ``tools/roll_release.sh``. This
script automatically tag the with the corresponding release number. The
script requires that you have the |stellar| Group signing key.

#. Update the websites (`stellar-group.org <https://stellar-group.org>`_ and
`stellar.cct.lsu.edu <https://stellar.cct.lsu.edu>`_) with the following:
Expand All @@ -167,11 +154,6 @@ are completed to avoid confusion.

#. Change ``HPX_VERSION_TAG`` in ``CMakeLists.txt`` back to ``-trunk``.

#. Switch Buildbot back to test the main branch

* ``https://github.com/STEllAR-GROUP/hermione-buildbot/blob/rostam/master/master.cfg``
* ``branch`` field in ``c['change_source'] = GitPoller``

#. Update Vcpkg (``https://github.com/Microsoft/vcpkg``) to pull from latest release.

* Update version number in CONTROL
Expand All @@ -184,4 +166,3 @@ are completed to avoid confusion.
HPC, Heise Online, and a CCT press release.

#. Beer and pizza.

Loading

0 comments on commit a78ab52

Please sign in to comment.