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

📖 Refine copy for PR template and add a release-note code fence #1678

Merged
merged 1 commit into from
Feb 25, 2022

Conversation

justaugustus
Copy link
Member

What kind of change does this PR introduce?

(Is it a bug fix, feature, docs update, something else?)

What is the current behavior?

See https://github.com/ossf/scorecard/blob/504f13441636dcc6273d45d9dc1e7ea1ef080ae2/.github/PULL_REQUEST_TEMPLATE.md.

What is the new behavior (if this is a feature change)?**

  • (N/A) Tests for the changes have been added (for bug fixes/features)

Adding a release-note code fence will allow us to start leverage the Kubernetes release-notes tool: https://git.k8s.io/release/cmd/release-notes/README.md

See comparison

https://github.com/ossf/scorecard/releases/tag/v4.1.0:

Screen Shot 2022-02-24 at 19 11 34

https://github.com/kubernetes/release/releases/tag/v0.13.0:

Screen Shot 2022-02-24 at 19 12 11

Which issue(s) this PR fixes

Partially addresses #1677.

Special notes for your reviewer

I've used the proposed PR template for this PR and added a fake release note that we can later test against.

Does this PR introduce a user-facing change?

For user-facing changes, please add a concise, human-readable release note to
the release-note

(In particular, describe what changes users might need to make in their
application as a result of this pull request.)

Fake release note for future testing

@justaugustus justaugustus temporarily deployed to integration-test February 25, 2022 00:14 Inactive
@justaugustus
Copy link
Member Author

cc: @ossf/scorecard-maintainers

@codecov
Copy link

codecov bot commented Feb 25, 2022

Codecov Report

Merging #1678 (5fe8f45) into main (504f134) will increase coverage by 3.18%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #1678      +/-   ##
==========================================
+ Coverage   58.50%   61.69%   +3.18%     
==========================================
  Files          58       58              
  Lines        5801     5801              
==========================================
+ Hits         3394     3579     +185     
+ Misses       2170     1979     -191     
- Partials      237      243       +6     

@justaugustus justaugustus requested a review from a team February 25, 2022 00:19
@github-actions
Copy link

Integration tests success for
[5fe8f45]
(https://github.com/ossf/scorecard/actions/runs/1896052754)

Copy link
Member

@naveensrinivasan naveensrinivasan left a comment

Choose a reason for hiding this comment

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

I like this. Thanks!

@justaugustus justaugustus merged commit 692c682 into ossf:main Feb 25, 2022
Copy link
Contributor

@azeemshaikh38 azeemshaikh38 left a comment

Choose a reason for hiding this comment

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

Awesome, thanks!

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.

3 participants