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

Bootstrap repository, prep for v1.0.0 #1

Merged
merged 12 commits into from
Apr 18, 2024
Merged

Bootstrap repository, prep for v1.0.0 #1

merged 12 commits into from
Apr 18, 2024

Conversation

nwiltsie
Copy link
Member

Description

As discussed in the Infrastructure Working group and in https://github.com/uclahs-cds/group-infrastructure/discussions/62, this repository is intended to be a centralized static analyzer Action for pull requests. The existing internal repository https://github.com/uclahs-cds/docker-CICD-base has a ton of history and has evolved quite a bit, so for simplicity we're starting fresh with this new repository.

Eventually this repo should absorb the Dockerfile and linting code, but as the associated package is already public that's not an immediate concern.

Action

The Action is relatively straightforward. The one wrinkle is that, at least for now, I want to provide the docker image tag as an input to the Action. Unfortunately, composite Actions explicitly have no access to the ${{ inputs }} context, so the Action has to do a little templating (inspiration) in order to work.

Versioning

GitHub's advice for versioning is to use immutable SemVer tags (e.g. v1.0.1) and mutable major version tags (e.g. v1). The major version tags always point to the latest matching SemVer tag and are what most people should use.

Once this PR is merged I will create the v1.0.0 release and the lightweight v1 tag pointing to it.

Workflow Name / Status Check

I experimented with this Action in this PR. After some back-and-forth I settled on using a workflow named CI and a job named static-analysis:

Screenshot 2024-04-16 at 3 25 36 PM

Interestingly only the job name matters for required status checks:

Screenshot 2024-04-16 at 3 26 56 PM

As we replace the existing workflows with references to this Action, so too would we replace required checks of CICD-base with static-analysis.

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 April 16, 2024 22:41
@yashpatel6 yashpatel6 self-assigned this Apr 17, 2024
@nwiltsie
Copy link
Member Author

Well, I feel a little silly - I just found https://github.com/uclahs-cds/tool-StaticCodeAnalysis. Mine is better, though!

action.yml Show resolved Hide resolved
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! Anything else to add from @dan-knight or @aholmes ?

action.yml Show resolved Hide resolved
@nwiltsie nwiltsie merged commit c0fe911 into main Apr 18, 2024
5 checks passed
@nwiltsie nwiltsie deleted the nwiltsie-bootstrap branch April 18, 2024 22:04
nwiltsie added a commit that referenced this pull request Apr 18, 2024
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