Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Fixes on COVERALLS_FLAG_NAME and COVERALLS_REPO_TOKEN for GitHub Actions #244

Merged
merged 1 commit into from Jan 12, 2021

Conversation

andy-maier
Copy link
Contributor

Addresses #243

…b Actions

Details:

* The docs section 'Github Actions Gotcha' stated that the COVERALLS_FLAG_NAME
  env var is needed in order to avoid 'pile up of jobs'. It turns out that
  it is optional, and when specified, can be specified with the same value
  across all jobs or with unique values.
  This change clarifies that in the documentation.

* This change also clarifies that the COVERALLS_REPO_TOKEN env var is not needed
  for GitHub Actions.

* This change also renames the heading of the section to 'Github Actions support'
  to have a more neutral name.

Signed-off-by: Andreas Maier <andreas.r.maier@gmx.de>
Copy link
Owner

@TheKevJames TheKevJames left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@andy-maier thanks for the contribution, and I appreciate you helping to clean things up here. As you mentioned in #243, I think it would be useful to mention something about the "piling up" of jobs, even if it's not something we can fix. Could you include something to that effect here, to make sure users know that is expected?

@TheKevJames
Copy link
Owner

Merging as this is a net improvement, but would love if you (@andy-maier ) had more info to add on the "piling up jobs" thing!

@TheKevJames TheKevJames merged commit 14cea5a into TheKevJames:master Jan 12, 2021
andy-maier added a commit to andy-maier/coveralls-python that referenced this pull request Dec 23, 2022
Details:

* The docs section 'Github Actions Gotcha' stated that the COVERALLS_FLAG_NAME
  env var is needed in order to avoid 'pile up of jobs'. It turns out that
  it is optional, and when specified, can be specified with the same value
  across all jobs or with unique values.
  This change clarifies that in the documentation.

* This change also clarifies that the COVERALLS_REPO_TOKEN env var is not needed
  for GitHub Actions.

* This change also renames the heading of the section to 'Github Actions support'
  to have a more neutral name.

Signed-off-by: Andreas Maier <andreas.r.maier@gmx.de>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants