CLI options are deprecated. Please update README and offer alternatives if they exist.

[smcclure15]

$ curl -L https://coveralls.io/coveralls-linux.tar.gz | tar -xz -C .
$ ./coveralls --help
Coveralls Coverage Reporter v0.6.14
Usage: coveralls [command] [options]
    report                           Report coverage
    done                             Call a webhook after all parallel reports
    version                          Show version
    --debug                          Debug mode: data being sent to Coveralls will be printed to console
    --dry-run                        Dry run (no request sent)
    --no-fail                        Always exit with status 0
    -n, --no-logo                    Do not show Coveralls logo in logs
    -q, --quiet                      Suppress all output
    -h, --help                       Show this help
    -rTOKEN, --repo-token=TOKEN      Sets coveralls repo token, overrides settings in yaml or environment variable
    -cPATH, --config-path=PATH       Set the coveralls yaml config file location, will default to check '.coveralls.yml'
    -bPATH, --base-path=PATH         DEPRECATED: Path to the root folder of the project the coverage was collected in
    -fFILENAME, --file=FILENAME      DEPRECATED: Coverage artifact file to be reported, e.g. coverage/lcov.info (detected by default)
    -jFLAG, --job-flag=FLAG          DEPRECATED: Coverage job flag name, e.g. Unit Tests
    -p, --parallel                   DEPRECATED: Set the parallel flag. Requires webhook for completion (coveralls done)
    -d, --done                       DEPRECATED: Call webhook after all parallel jobs (-p) done
    --format=FORMAT                  DEPRECATED: Force coverage file format, supported formats: clover, cobertura, jacoco, golang, python, coveralls, lcov, simplecov, gcov
    --allow-empty                    DEPRECATED: Allow empty coverage results and exit 0
    --compare-ref=REF                DEPRECATED: Git branch name to compare the coverage with
    --compare-sha=SHA                DEPRECATED: Git commit SHA to compare the coverage with
    --carryforward=FLAGS             DEPRECATED: Comma-separated list of parallel job flags
    --service-name=NAME              DEPRECATED: Build service name override
    --service-job-id=ID              DEPRECATED: Build job override
    --service-build-url=URL          DEPRECATED: Build URL override
    --service-job-url=URL            DEPRECATED: Build job URL override
    --service-branch=NAME            DEPRECATED: Branch name override
    --service-pull-request=NUMBER    DEPRECATED: PR number override
    -v, --version                    DEPRECATED: Show version

I was anticipating using things like the job id and PR numbers, but I found those to be deprecated. Are there env vars to leverage instead?

[afinetooth]

@smcclure15 yes, you can find those here (linked from here in the README).

(And more documentation on those here as well.)

Between these two options for Build ID---the label you want to be given to your builds at Coveralls:

• COVERALLS_SERVICE_JOB_NUMBER
• COVERALLS_SERVICE_JOB_ID

You'll want to use COVERALLS_SERVICE_JOB_NUMBER, if that is your purpose.

You then have the option to set that to whatever CI env var you like. With GitHub Actions, the default is GITHUB_RUN_ID, but you could, alternatively, use GITHUB_SHA for instance, if you wanted your build IDs to be equivalent to your GitHub SHAs.

COVERALLS_PULL_REQUEST or CI_PULL_REQUEST will work for setting your PR number, but that is also the default for GitHub Actions (GITHUB_REF).

If you'd like any more assistance with customizing your config, let me know here, or email [email protected].