Skip to content

Commit

Permalink
Consolidate release notes
Browse files Browse the repository at this point in the history
  • Loading branch information
clelange committed Jul 25, 2024
1 parent f9c64b2 commit d664cd4
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 14 deletions.
8 changes: 7 additions & 1 deletion docs/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,15 @@ Choose the tag you just created, auto-generate release notes, and click "Publish
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/
.. _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/
13 changes: 0 additions & 13 deletions docs/dev.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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/

0 comments on commit d664cd4

Please sign in to comment.