Make installing from the git archive of a tagged commit possible

aka make GitHub release assets usable.

Requires setuptools-scm-git-archive.
This commit is contained in:
Chris Mayo 2021-12-06 19:40:02 +00:00
parent b6d97be46c
commit d2d2a563cc
4 changed files with 11 additions and 1 deletions

1
.git_archival.txt Normal file
View file

@ -0,0 +1 @@
ref-names: $Format:%D$

1
.gitattributes vendored
View file

@ -1,3 +1,4 @@
.git_archival.txt export-subst
.gitattributes export-ignore
.gitignore export-ignore
/doc/web export-ignore

View file

@ -74,4 +74,4 @@ Release process
8. check distribution files (`twine check dist/*`) and upload to PyPI (`twine upload dist/*`)
9. create release (vX.Y.Z) on GitHub (warn users about GitHub archives)
9. create release (vX.Y.Z) on GitHub

View file

@ -7,6 +7,10 @@ When installing from source, for application translations to be installed
polib_ needs to be installed before LinkChecker. After LinkChecker installation
polib_ can be removed.
Installing from the GitHub release assets requires setuptools-scm-git-archive_.
pip-run_ may be useful for both of these cases.
There are several steps to resolve problems with detecting the character
encoding of checked HTML pages:
first ensure the web server, if used, is not returning an incorrect charset in
@ -20,10 +24,14 @@ used.
.. _chardet: https://pypi.org/project/chardet/
.. _pip-run: https://pypi.org/project/pip-run/
.. _cchardet: https://pypi.org/project/cchardet/
.. _polib: https://pypi.org/project/polib/
.. _setuptools-scm-git-archive: https://pypi.org/project/setuptools-scm-git-archive/
.. _venv: https://docs.python.org/3/library/venv.html#creating-virtual-environments
Setup with pip