https://github.com/datreeio/datree-pr-checks
datree catalog - in context of your pull requests
https://github.com/datreeio/datree-pr-checks
Last synced: about 1 year ago
JSON representation
datree catalog - in context of your pull requests
- Host: GitHub
- URL: https://github.com/datreeio/datree-pr-checks
- Owner: datreeio
- Created: 2018-07-23T08:40:04.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2019-06-20T11:22:48.000Z (almost 7 years ago)
- Last Synced: 2025-03-25T19:51:07.170Z (about 1 year ago)
- Language: JavaScript
- Homepage: https://www.datree.io/
- Size: 18.6 KB
- Stars: 6
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Harness the intelligence of datree’s code components catalog in the context of your pull request! :sunglasses:
datree can be integrated with GitHub checks, so for every pull request, the datree BOT will provide a layer of best practices & insights based on your organization’s catalog.
***
### Best Practices Layer:
:black_small_square: Do not include secret file(s)
:black_small_square: Include mandatory files: .gitignore
:black_small_square: Keep project dependencies dir out
:black_small_square: Block unverified user(s)
:black_small_square: Check code component version
:black_small_square: Verify changes in related files: manifest & manifest-lock
:black_small_square: Exclude unwanted files: personal files
***
### Insights Layer:
#### 1) Repository Related:
:black_small_square: When was the last commit to the default branch
:black_small_square: When was the last commit by the pull request opener to the default branch
:black_small_square: What is the code contributing percentage by the pull request opener to the default branch
#### 2) Code Components Related:
|Categories|Event Details|
|:---|:---|
|:tada: New Code Components | New code components in the scope of your repository and organization|
|:package: Version Changes | All the version changes (upgrade / downgrade) made in the pull request |
|:outbox_tray: Removed Code Components | Code components which were removed from your manifest file |
|:chart_with_upwards_trend: Usage Digest | Each file related to a specific code component-related event (added / updated / removed) |
:point_right: We also provide the number of people and repositories in your organization using each code component, and update you whenever there is a **new code component** in your organization’s dev stack! :point_left:
***
### Cut the BS (:poop:), I want to see what it looks like!
You can checkout the open pull requests in this repository - [this one](https://github.com/datreeio/datree-pr-checks/pull/5/checks?check_run_id=9131499) is a good exmaple :octocat:
***
### :book: Glossary
**Code Components** - These are the building blocks used to build applications and have a footprint in your codebase. Code component can be different types of technologies (e.g. docker), open source (e.g npm/express), internal packages or any other “lego bricks” defined by the organization.