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

📖 explicitly state both check documentation files are committed #4317

Merged
merged 2 commits into from
Sep 20, 2024

Conversation

spencerschrock
Copy link
Member

What kind of change does this PR introduce?

doc update

What is the current behavior?

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

Clarify that both check files should be committed in order to pass the generate-docs CI job.

- name: ensure generated check and probe documentation match the source
run: git diff --exit-code

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

Which issue(s) this PR fixes

See #4316 (review)

Special notes for your reviewer

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.)

NONE

@spencerschrock spencerschrock requested review from a team, justaugustus and raghavkaul and removed request for a team August 28, 2024 21:53
@spencerschrock
Copy link
Member Author

Friendly ping @raghavkaul @justaugustus

@spencerschrock spencerschrock enabled auto-merge (squash) September 20, 2024 17:38
@spencerschrock spencerschrock merged commit 7b07a8d into ossf:main Sep 20, 2024
36 checks passed
@spencerschrock spencerschrock deleted the contributing-doc-update branch September 20, 2024 17:44
balteravishay pushed a commit to balteravishay/scorecard that referenced this pull request Sep 29, 2024
balteravishay pushed a commit to balteravishay/scorecard that referenced this pull request Oct 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants