Common Git Repo artifacts enforcement
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
Research direction
Start by reading the linked TODO Group repolinter documentation and Philips Labs' Continuous Compliance Action README, then compare their capabilities with the listed SECURITY.md, CODE_OF_CONDUCT.md, and GitHub Actions workflow requirements. Clarify the repository scope and configuration location before designing the meta-validation workflow. Done would mean consistent checks can be run across the organization's repositories and report compliance gaps.
Written by the indexing model from the issue text.
Description
Certain artifacts such as SECURITY.md, CODE_OF_CONDUCT.md, and certain GitHub Actions Workflow files need to be consistent across our GitHub Repositories. To achieve this, we can utilise TODO Group's repolinter, which provides an epressive, declarative JSON- and YAML-based format for validating the existence of files and directories and validating file hashes, just to name a few. Notably, repolinter supports remote URLs for its configuration file, which we can exploit to ensure a consistent configuration that's hosted in this Git Repository.
In addition repolinter can be used to either scan the current or remote Git Repositories, which allows us to perform "meta validation" whereby we host a GitHub Action Workflow in this Git Repository to periodically scan all of our Git Repositories for a standardised GitHub Action Workflow which triggers the repolinter scans for that Git Repository.
TODO Group is under the Linux Foundation, and repolinter can be considered a mature project.
Philips Labs' Continuous Compliance Action is a fork of repolinter with some additional features which attempt to complete the compliance reporting lifecycle. From its README:
We started working on a fork of Repolinter, one that introduced the ability create different GitHub issues per rule that was broken.
Currently it's considered a work-in-progress, and could be considered as an alternative to repolinter.
For certain artifacts such as SECURITY.md and CODE_OF_CONDUCT.md, GitHub can provide links to a centralised copy hosted in the .github Git Repository for those that don't already have their own. This is what the Node.js GitHub Organisation is doing: https://github.com/nodejs/admin/issues/644. However, the tradeoffs are:
- Only limited artifacts are replicated
- GitHub Action Workflows cannot be replicated
- These artifacts are not visible when performing a
git pullto a local machine
- Dominant language
- Shell
- Stars
- 0
- Forks
- 0
- Avg merge
- 1d 3h
- Merged PRs (30d)
- 2
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from loopbackio/cicd
-
Difficulty 3/5 1-2 days Newbie friendliness 38/100
loopbackio/cicd#170 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 45/100
loopbackio/cicd#91 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 45/100
loopbackio/cicd#89 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
loopbackio/cicd#39 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
loopbackio/cicd#26 ·
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
danielmiessler/LifeOS#2218 ·
-
docs(agents): strengthen the no-backslash-escaped-backticks rule with an issue-creation example Open
Difficulty 1/5 Under an hour Newbie friendliness 92/100
-
technical-debt
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
ll7/robot_sf_ll7#9560 ·
-
package-update
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
oSoWoSo/vOid_Community_repOsitory#148 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100