From 53771264dc12851f22652da70d479662275a2d81 Mon Sep 17 00:00:00 2001 From: Clemens Lange Date: Thu, 25 Jul 2024 19:04:38 +0200 Subject: [PATCH] Update release creation docs (#269) * Update release creation docs * Consolidate release notes * Update copyright year --- docs/conf.py | 2 +- docs/contributing.rst | 44 ++++++++++++++----------------------------- docs/dev.rst | 13 ------------- 3 files changed, 15 insertions(+), 44 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index e27ef6db..19371a48 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -35,7 +35,7 @@ def __getattr__(cls, name): # -- Project information ----------------------------------------------------- project = 'hepdata_lib' -copyright = '2018-2023, Andreas Albert, Clemens Lange' +copyright = '2018-2024, Andreas Albert, Clemens Lange' author = 'Andreas Albert, Clemens Lange' # The short X.Y version diff --git a/docs/contributing.rst b/docs/contributing.rst index cb4eae9e..5bd10fd5 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -33,40 +33,24 @@ The files in which the versions are updated as well as the current version can b .. _sec-dev-pypi: -Uploading to PyPI ------------------ +Creating a new release +--------------------------- -Once a new version has been tagged, the package should be uploaded to the Python Package Index (PyPI_). -For the markdown formatting to work, ``twine>=1.11.0`` is required. -Execute the following commands to create a source distribution and upload it: - -:: - - pip install -U wheel - python setup.py sdist bdist_wheel - pip install -U twine - twine upload --repository-url https://test.pypi.org/legacy/ dist/* - -This uploads to the `PyPI test server`_. Mind that you need to have an account for both the test and the production servers. - -Install the package for testing: - -:: - - pip install --index-url https://test.pypi.org/simple/ hepdata_lib - -If everything is fine, upload to the production server: - -:: - - twine upload dist/* - -You should then find the new version at `this location`_. You need to be a maintainer of the project for this to work. For more details please see the `python packaging documentation`_. +Once a new version has been tagged, a new release has to be created on GitHub. +Go to `Releases`_ and click on "Draft a new release". +Choose the tag you just created, auto-generate release notes, and click "Publish release". +The package will then be automatically uploaded to the Python Package Index (PyPI_) at `this location`_ +and a new container image will be built and tagged. +After making a new release available on `PyPI`_, a `JIRA`_ issue (`example`_) should be opened to request that +``hepdata_lib`` is upgraded in future `LCG Releases`_ used by `SWAN`_. .. _bumpversion: https://github.com/peritus/bumpversion .. _.bumpversion.cfg: https://github.com/HEPData/hepdata_lib/blob/main/.bumpversion.cfg +.. _Releases: https://github.com/HEPData/hepdata_lib/releases .. _PyPI: https://pypi.org -.. _PyPI test server: https://test.pypi.org/project/hepdata_lib/ .. _this location: https://pypi.org/project/hepdata_lib/ -.. _python packaging documentation: https://packaging.python.org/tutorials/packaging-projects/ +.. _JIRA: https://its.cern.ch/jira/projects/SPI/ +.. _example: https://its.cern.ch/jira/browse/SPI-2507 +.. _LCG Releases: https://lcginfo.cern.ch/pkg/hepdata_lib/ +.. _SWAN: http://swan.cern.ch/ diff --git a/docs/dev.rst b/docs/dev.rst index e3a5e1b5..4ac04f40 100644 --- a/docs/dev.rst +++ b/docs/dev.rst @@ -129,16 +129,3 @@ Analysing the code These commands are run by GitHub Actions (for Python 3.8 or later), so you should first check locally that no issues are flagged. - - -Making a release ----------------- - -After making a new release available on `PyPI`_, a `JIRA`_ issue (`example`_) should be opened to request that -``hepdata_lib`` is upgraded in future `LCG Releases`_ used by `SWAN`_. - -.. _PyPI: https://pypi.org/project/hepdata-lib/ -.. _JIRA: https://its.cern.ch/jira/projects/SPI/ -.. _example: https://its.cern.ch/jira/browse/SPI-2507 -.. _LCG Releases: https://lcginfo.cern.ch/pkg/hepdata_lib/ -.. _SWAN: http://swan.cern.ch/ \ No newline at end of file