-
Notifications
You must be signed in to change notification settings - Fork 0
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
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Well, I feel a little silly - I just found https://github.com/uclahs-cds/tool-StaticCodeAnalysis. Mine is better, though! |
yashpatel6
reviewed
Apr 17, 2024
yashpatel6
approved these changes
Apr 18, 2024
There was a problem hiding this 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 ?
aholmes
reviewed
Apr 18, 2024
aholmes
approved these changes
Apr 18, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 lightweightv1
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 namedstatic-analysis
:Interestingly only the job name matters for required status checks:
As we replace the existing workflows with references to this Action, so too would we replace required checks of
CICD-base
withstatic-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.
.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
UCLA Health reaches $7.5m settlement over 2015 breach of 4.5m patient records ↩
The average healthcare data breach costs $2.2 million, despite the majority of breaches releasing fewer than 500 records. ↩
Genetic information is considered PHI.
Forensic assays can identify patients with as few as 21 SNPs ↩
RNA-Seq, DNA methylation, microbiome, or other molecular data can be used to predict genotypes (PHI) and reveal a patient's identity. ↩