Skip to content

Commit

Permalink
chore(backport): Remove codemeta from repository (#2506)
Browse files Browse the repository at this point in the history
* Backport PR #2490
* Remove all files, tests, and documentation related to codemeta,
  codemeta.json, and codemetapy.
* codemeta is not realistically used for anything useful and codemetapy
  is not maintained, so there is no strong reason to keep using codemeta
  or to have a codemeta.json.
  • Loading branch information
matthewfeickert authored May 30, 2024
1 parent 7d2b257 commit 1dc2b7e
Show file tree
Hide file tree
Showing 6 changed files with 3 additions and 168 deletions.
1 change: 0 additions & 1 deletion .github/ISSUE_TEMPLATE/~release-checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ about: Checklist for core developers to complete as part of making a release
* [ ] Verify that the release notes files correctly summarize all development changes since the last release.
* [ ] Add any new use citations or published statistical models to the [Use and Citations page][citations_page].
* [ ] Verify that the citations on the [Use and Citations page][citations_page] are up to date with their current [INSPIRE](https://inspirehep.net/) record. Checking the [Dimensions listing of publication citations](https://app.dimensions.ai/discover/publication?or_subset_publication_citations=pub.1135154020) can be helpful to catch citations that are now journal publications.
* [ ] Update the ``codemeta.json`` file in the release PR if its requirements have updated.
* [ ] Update the [pypa/gh-action-pypi-publish](https://github.com/pypa/gh-action-pypi-publish) GitHub Action used for deployment to TestPyPI and PyPI to the latest stable release.
* [ ] Make a release to [TestPyPI][TestPyPI_pyhf] using the [workflow dispatch event trigger](https://github.com/scikit-hep/pyhf/actions/workflows/publish-package.yml).
* [ ] Verify that the project README is displaying correctly on [TestPyPI][TestPyPI_pyhf].
Expand Down
7 changes: 0 additions & 7 deletions .github/workflows/release_tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,3 @@ jobs:
# Though still show warnings by setting warning control to 'default'.
export PYTHONWARNINGS='default'
pytest tests/test_public_api.py
# FIXME: c.f. https://github.com/proycon/codemetapy/issues/24
- name: Verify requirements in codemeta.json
run: |
uv pip install --system jq "codemetapy>=2.3.0"
codemetapy --inputtype python --no-extras pyhf > codemeta_generated.json
diff <(jq -S .softwareRequirements codemeta.json) <(jq -S .softwareRequirements codemeta_generated.json)
143 changes: 0 additions & 143 deletions codemeta.json

This file was deleted.

16 changes: 3 additions & 13 deletions docs/development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -267,19 +267,9 @@ sdist and wheel, and then deploy them to PyPI_.
Context Files and Archive Metadata
----------------------------------

The ``.zenodo.json`` and ``codemeta.json`` files have the version number
automatically updated through ``tbump``, though their additional metadata
should be checked periodically by the dev team (probably every release).
The ``codemeta.json`` file can be generated automatically **from a PyPI install**
of ``pyhf`` using ``codemetapy``

.. code-block:: console
codemetapy --no-extras pyhf > codemeta.json
though the ``author`` metadata will still need to be checked and revised by hand.
The ``.zenodo.json`` is currently generated by hand, so it is worth using
``codemeta.json`` as a guide to edit it.
The ``.zenodo.json`` file has the version number automatically updated through
``tbump``, though its additional metadata should be checked periodically by
the dev team (probably every release).

.. _bump version GitHub Actions workflow: https://github.com/scikit-hep/pyhf/actions/workflows/bump-version.yml
.. _PyPI: https://pypi.org/project/pyhf/
Expand Down
1 change: 0 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,6 @@ develop = [
"tbump>=6.7.0",
"pre-commit",
"nox",
"codemetapy>=2.3.0",
]

[tool.hatch.version]
Expand Down
3 changes: 0 additions & 3 deletions tbump.toml
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,6 @@ src = "src/pyhf/data/citation.bib"
[[file]]
src = ".zenodo.json"

[[file]]
src = "codemeta.json"

[[file]]
src = "CITATION.cff"

Expand Down

0 comments on commit 1dc2b7e

Please sign in to comment.