Add security and coverage scanning to best practices for new repos #741
Conversation
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
arminru
requested review from
bhs,
bogdandrutu,
ccaraman,
dyladan,
lizthegrey,
mtwo,
sarahnovotny,
SergeyKanzhelev,
tedsuo and
yurishkuro
as code owners
yurishkuro
approved these changes
May 27, 2021
alolita
approved these changes
May 27, 2021
dyladan
approved these changes
May 27, 2021
|
|
||
| 1. Only set "Allow squash merging" for the Merge button. It will ensure clean | ||
| history for the repository. | ||
| 2. Set up a security scanning tool like, for example, [Github CodeQL](https://docs.github.com/en/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning). | ||
| 3. Set up a test coverage scanning tool like, for example, [Codecov](https://codecov.io/). |
There was a problem hiding this comment.
anything needs to be said about the recent security issue with codecov? What's the best practices now?
There was a problem hiding this comment.
I added it as an example based on the fact that most of our repos already use it: https://codecov.io/gh/open-telemetry. It would be odd to advise against using it while it's already being used heavily. If you think we should reconsider it and look for alternatives, we can leave it out as an example for now and tackle this separately.
SergeyKanzhelev
approved these changes
May 27, 2021
mtwo
approved these changes
May 28, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In open-telemetry/oteps#144 and open-telemetry/opentelemetry-specification#1333 CodeQL security scanning was enabled for most of our repositories and most of them already have Codecov coverage scanning set up. I think we should mention this in the new repo best practices so it's also considered right from the start when new repositories are created.