You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Create a new script to aid with publishing new releases.
On the basis of the make_release.sh script in the GitLab branch releases, this should include things such as:
creating release notes (providing a draft using the commit titles since the last release, also update doc/relnotes.md)
updating porting guides (rename unreleased.md -> new-releasename.md, create new unreleased.md)
updating the copyright year if that has not been done (?)
fixing version.h (eeeh... it probably should contain "unreleased" or similar for all of the commits in between releases...)
uploading a new post on the OGDF website including zipped source code
updating link to documentation of the latest release on the OGDF website^
building a docker image that can then be found at docker.com/ogdf/ogdf (once we have the technology – building such an image with the CI is a sub-task of CI improvements #103)^^
^If we use netlify in the future to build our documentation, there should be a link in the README.md and on the OGDF website to the latest commit doc that does not need to be updated. However, there should also be a link on the website to the doc of the latest release.
^^ Once created/updated, we should then also advertise docker/conan/vcpkg on the OGDF website...
The text was updated successfully, but these errors were encountered:
To prevent merge conflicts between parallel PRs, it would probably be easier to collect porting guides / change notes in individual files and then simply cat them together on release. For release notes and listing their constituent PRs / commits, there are also various more advanced tools (and also some guidelines here):
Things on GitHub can easily be automated using GitHub CI, which includes drafting the new release as well as creating PRs for vcpkg, conan and ogdf-wheel/PyPi (or at least creating an issue with ToDos for that)
To orchestrate all this together with incrementing the version numbers in all places and creating the corresponding git commits, there are very useful tools like bump-my-version or tbump (or even more here). This also makes it easy to first bump the version to a release and then immediately afterwards to a development version of the next version (which would fix the inconsistency with version.h). This also what I do with ogdf-python.
Uh oh!
There was an error while loading. Please reload this page.
Create a new script to aid with publishing new releases.
On the basis of the
make_release.sh
script in the GitLab branch releases, this should include things such as:doc/relnotes.md
)version.h
(eeeh... it probably should contain "unreleased" or similar for all of the commits in between releases...)^If we use netlify in the future to build our documentation, there should be a link in the README.md and on the OGDF website to the latest commit doc that does not need to be updated. However, there should also be a link on the website to the doc of the latest release.
^^ Once created/updated, we should then also advertise docker/conan/vcpkg on the OGDF website...
The text was updated successfully, but these errors were encountered: