-
-
Notifications
You must be signed in to change notification settings - Fork 187
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(envs): clean up git-env-var docs and some typos
- Loading branch information
1 parent
9ab6c26
commit a9c1ce3
Showing
4 changed files
with
51 additions
and
39 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -10,6 +10,7 @@ Getting Started | |
|
||
usage/index | ||
usage/configuration | ||
usage/vcsconfig | ||
usage/tox | ||
usage/multilang | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
.. _vcsconfig: | ||
|
||
VCS Configuration | ||
================= | ||
|
||
``coveralls-python`` supports ``git`` by default and will run the necessary ``git`` commands to collect the required information without any intervention. | ||
|
||
As describe in `the coveralls docs`_, you may also configure these values by setting environment variables. These will be used in the fallback case, eg. if ``git`` is not available or your project is not a ``git`` repository. | ||
|
||
As described in the linked documentation, you can also use this method to support non- ``git`` projects:: | ||
|
||
GIT_ID=$(hg tip --template '{node}\n') | ||
GIT_AUTHOR_NAME=$(hg tip --template '{author|person}\n') | ||
GIT_AUTHOR_EMAIL=$(hg tip --template '{author|email}\n') | ||
GIT_COMMITTER_NAME=$(hg tip --template '{author|person}\n') | ||
GIT_COMMITTER_EMAIL=$(hg tip --template '{author|email}\n') | ||
GIT_MESSAGE=$(hg tip --template '{desc}\n') | ||
GIT_BRANCH=$(hg branch) | ||
|
||
.. _the coveralls docs: https://docs.coveralls.io/mercurial-support |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters