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

Move linting configuration to .cicd-env file #13

Merged
merged 2 commits into from
Oct 5, 2023

Conversation

nwiltsie
Copy link
Member

@nwiltsie nwiltsie commented Oct 4, 2023

Description

This is a super-simple change that moves the linting configuration from the GitHub workflow file to a new .cicd-env file. There are no "real" changes to this package.

I added a flag to skip the "no repositories named public- or private-" test. For backwards compatibility that test currently only produces a warning, but once we either rename or add specific ignore rules to each offending repo we can properly enable it.

This change enables the new bllint script from https://github.com/uclahs-cds/docker-CICD-base/pull/60 to lint a checked-out copy of this repository for easier development.

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.

@dan-knight
Copy link
Contributor

If we add a file like this, we also need to include it in Rbuildignore so it isn't included in the built package.

For clarity, this change is mainly for compatibility with bllint, correct? If so, we should make this change to all R package repos for consistency. (Forgive me if you're already on top of it.)

@nwiltsie
Copy link
Member Author

nwiltsie commented Oct 5, 2023

Good to know, I'll get it added to Rbuildignore tomorrow morning. And yes, I'm slowly doing this organization-wide.

Copy link
Contributor

@dan-knight dan-knight left a comment

Choose a reason for hiding this comment

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

LGTM!

@nwiltsie nwiltsie merged commit 96d529d into main Oct 5, 2023
3 checks passed
@nwiltsie nwiltsie deleted the nwiltsie_update_linting branch October 5, 2023 17:19
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.

2 participants