Skip to content

Commit

Permalink
docs(api): update CI_* env var descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
abravalheri committed Jun 14, 2021
1 parent 50c8e51 commit fba8351
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 5 deletions.
3 changes: 3 additions & 0 deletions coveralls/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,9 @@ def load_config_from_generic_ci_environment(self):
# coveralls-ruby in lib/coveralls/configuration.rb
# (set_standard_service_params_for_generic_ci)

# The meaning of each env var is clarified in:
# https://github.com/lemurheavy/coveralls-public/issues/1558

config = {
'service_name': os.environ.get('CI_NAME'),
'service_number': os.environ.get('CI_BUILD_NUMBER'),
Expand Down
11 changes: 6 additions & 5 deletions docs/usage/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -168,15 +168,16 @@ defined::
CI_NAME
# Name of the CI service being used
CI_BUILD_NUMBER
# Number (counter) relative to the current build
# The number assigned to the build by your CI service.
CI_BUILD_URL
# URL to a webpage showing the build information/output
# URL to a webpage showing the build information/logs
CI_BRANCH
# For pull requests this is the name of the branch targeted by the PR,
# For pull requests this is the name of the branch being targeted,
# otherwise it corresponds to the name of the current branch or tag
CI_JOB_ID (optional)
# Unique identifier of the job in the CI service.
# When missing, CI_BUILD_NUMBER is used
# For parallel builds, the number assigned to each job comprising the build.
# When missing, Coveralls will assign an incrementing integer (1, 2, 3 ...).
# This value should not change between multiple runs of the build.
CI_PULL_REQUEST (optional)
# If given, corresponds to the number of the pull request, as specified
# in the supported repository hosting service (GitHub, GitLab, etc)

0 comments on commit fba8351

Please sign in to comment.