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

[repo] markdownlint ci changes #5281

Merged
merged 11 commits into from
Jan 29, 2024

Conversation

CodeBlanch
Copy link
Member

Changes

Merge requirement checklist

  • CONTRIBUTING guidelines followed (license requirements, nullable enabled, static analysis, etc.)

@CodeBlanch CodeBlanch requested a review from a team January 29, 2024 23:44
@CodeBlanch CodeBlanch added the infra Infra work - CI/CD, code coverage, linters label Jan 29, 2024
Copy link

codecov bot commented Jan 29, 2024

Codecov Report

Attention: 16 lines in your changes are missing coverage. Please review.

Comparison is base (6250307) 83.38% compared to head (31c69f9) 83.07%.
Report is 38 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #5281      +/-   ##
==========================================
- Coverage   83.38%   83.07%   -0.31%     
==========================================
  Files         297      272      -25     
  Lines       12531    11965     -566     
==========================================
- Hits        10449     9940     -509     
+ Misses       2082     2025      -57     
Flag Coverage Δ
unittests ?
unittests-Instrumentation-Experimental 24.92% <93.75%> (?)
unittests-Instrumentation-Stable 24.92% <93.75%> (?)
unittests-Solution-Experimental 82.96% <54.28%> (?)
unittests-Solution-Stable 83.02% <54.28%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Coverage Δ
...etryProtocol/Implementation/ExperimentalOptions.cs 100.00% <ø> (ø)
...tation/OpenTelemetryProtocolExporterEventSource.cs 100.00% <100.00%> (ø)
...rotocol/Implementation/OtlpLogRecordTransformer.cs 93.45% <100.00%> (ø)
...tation.AspNetCore/Implementation/HttpInListener.cs 89.79% <100.00%> (+0.21%) ⬆️
...AspNetCore/Implementation/HttpInMetricsListener.cs 89.74% <100.00%> (+0.26%) ⬆️
....GrpcNetClient/GrpcClientInstrumentationOptions.cs 100.00% <ø> (+25.00%) ⬆️
...ent/Implementation/GrpcClientDiagnosticListener.cs 75.80% <100.00%> (-2.77%) ⬇️
...n.GrpcNetClient/TracerProviderBuilderExtensions.cs 100.00% <100.00%> (ø)
...plementation/HttpWebRequestActivitySource.netfx.cs 80.77% <100.00%> (ø)
...emetry/Metrics/Exemplar/SimpleExemplarReservoir.cs 80.43% <100.00%> (ø)
... and 1 more

... and 34 files with indirect coverage changes

@CodeBlanch CodeBlanch mentioned this pull request Jan 29, 2024
- name: run markdownlint
run: markdownlint .
uses: DavidAnson/markdownlint-cli2-action@v14.0.0
Copy link
Member

Choose a reason for hiding this comment

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

I have a general question - how do we decide when to trust something like this or not?

Copy link
Member

Choose a reason for hiding this comment

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

I'd hope that this will be more secure. I assume that now that we're using an actual version rather than just blindly downloading the latest, that dependabot can help alert us of vulnerabilities

Copy link
Member Author

Choose a reason for hiding this comment

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

It is a great question and I don't have an answer other than it is something we should discuss on SIG 🤣

Some thoughts...

  • This particular thing DavidAnson/markdownlint-cli2-action seems to be made by the same guy who makes markdownlint itself so high confidence here.

  • There is table which shows permissions for "pull requests from public forked repositories": https://docs.github.com/en/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token

    I don't worry much about the CI workflow(s) because it seems GitHub has a pretty good safe-by-default policy. I would worry more about a release job using random actions but for this repo we don't have a release job (we do it manually). The contrib repo does use workflows to release though.

@CodeBlanch CodeBlanch merged commit 48db3e1 into open-telemetry:main Jan 29, 2024
49 checks passed
@CodeBlanch CodeBlanch deleted the repo-markdownlint-fix branch January 30, 2024 00:11
@Kielek Kielek mentioned this pull request Jan 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
infra Infra work - CI/CD, code coverage, linters
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants