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

Add instructions for README badges, update templates to major alias #20

Merged
merged 6 commits into from
Oct 18, 2024

Conversation

nwiltsie
Copy link
Member

Description

This adds a fancy badge to the README showing the current GitHub release and linking to the release workflow:

GitHub release

It also adds instructions on how to add matching badges to calling repositories. Two points of frustration there:

Prepare release

Finally, I cleaned up the template workflows:

  • I removed all of the Secrets are only required until... comments. It's just easier to keep using secrets.
  • I commented-out the draft parameter to the finalization workflow. Users copying the template can easily uncomment it, but it makes the drafting behavior opt-in.
  • I changed the workflow versions from v1.0.0 to v1. That'll eliminate the need for dependabot to bump anything except major versions. This is safe because it's our own workflow; any non-uclahs-cds users of these workflows should stick with the full version.

Closes #11

Checklist

  • This PR does NOT contain Protected Health Information (PHI). A repo may need to be deleted if such data is uploaded.
    Disclosing PHI is a major problem1 - Even a small leak can be costly2.

  • This PR does NOT contain germline genetic data3, RNA-Seq, DNA methylation, microbiome or other molecular data4.

  • This PR does NOT contain other non-plain text files, such as: compressed files, images (e.g. .png, .jpeg), .pdf, .RData, .xlsx, .doc, .ppt, or other output files.

  To automatically exclude such files using a .gitignore file, see here for example.

  • I have read the code review guidelines and the code review best practice on GitHub check-list.

  • I have set up or verified the main branch protection rule following the github standards before opening this pull request.

  • The name of the branch is meaningful and well formatted following the standards, using [AD_username (or 5 letters of AD if AD is too long)]-[brief_description_of_branch].

  • I have added the major changes included in this pull request to the CHANGELOG.md under the next release version or unreleased, and updated the date.

Footnotes

  1. UCLA Health reaches $7.5m settlement over 2015 breach of 4.5m patient records

  2. The average healthcare data breach costs $2.2 million, despite the majority of breaches releasing fewer than 500 records.

  3. Genetic information is considered PHI.
    Forensic assays can identify patients with as few as 21 SNPs

  4. RNA-Seq, DNA methylation, microbiome, or other molecular data can be used to predict genotypes (PHI) and reveal a patient's identity.

@nwiltsie nwiltsie requested a review from a team October 17, 2024 22:37
Copy link

@yashpatel6 yashpatel6 left a comment

Choose a reason for hiding this comment

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

Looks good to me!

@nwiltsie nwiltsie merged commit 9ac27ae into main Oct 18, 2024
7 checks passed
@nwiltsie nwiltsie deleted the nwiltsie-add-badge branch October 18, 2024 15:27
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.

Feature: Design a README badge
2 participants