Skip to content

Commit

Permalink
Merge branch 'master' into pretend-version
Browse files Browse the repository at this point in the history
  • Loading branch information
basnijholt authored Feb 26, 2024
2 parents a5a5f54 + b42dbb7 commit f41c952
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 8 deletions.
4 changes: 3 additions & 1 deletion .github/workflows/no-vcs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,10 @@ jobs:
tox -e py -- -vv --cov-report=xml
- name: Upload coverage to Codecov
uses: codecov/codecov-action@v3
uses: codecov/codecov-action@v4
with:
fail_ci_if_error: false
token: ${{ secrets.CODECOV_TOKEN }}
name: no-vcs

# vim:set et sts=2:
4 changes: 3 additions & 1 deletion .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -75,8 +75,10 @@ jobs:

- name: Upload coverage to Codecov
if: startsWith(matrix.toxenv, 'py')
uses: codecov/codecov-action@v3
uses: codecov/codecov-action@v4
with:
fail_ci_if_error: false
token: ${{ secrets.CODECOV_TOKEN }}
name: ${{ matrix.python-version }}

# vim:set et sts=2:
21 changes: 15 additions & 6 deletions docs/writing-methods.rst
Original file line number Diff line number Diff line change
Expand Up @@ -209,14 +209,23 @@ specify the method function as an entry point of the project. The name of the
entry point group is ``versioningit.STEP`` (though, for ``next-version`` and
``template-fields``, the group is spelled with an underscore instead of a
hyphen). For example, if you have a custom ``vcs`` method implemented as a
`foobar_vcs()` function in :file:`mypackage/vcs.py`, you would declare it in
:file:`setup.cfg` as follows:
`foobar_vcs()` function in :file:`mypackage/vcs.py`, you would declare it as
follows:

.. code:: ini
.. tab:: If using :file:`setup.cfg`

[options.entry_points]
versioningit.vcs =
foobar = mypackage.vcs:foobar_vcs
.. code:: ini
[options.entry_points]
versioningit.vcs =
foobar = mypackage.vcs:foobar_vcs
.. tab:: If using :file:`pyproject.toml`

.. code:: toml
[project.entry-points."versioningit.vcs"]
foobar = "mypackage.vcs:foobar_vcs"
Once your package is on PyPI, package developers can use it by including it in
their ``build-system.requires`` and specifying the name of the entry point (For
Expand Down

0 comments on commit f41c952

Please sign in to comment.