@jupiterone/graph-github v4.3.1
JupiterOne Integration
Learn about the data ingested, benefits of this integration, and how to use it with JupiterOne in the integration documentation.
Development
Prerequisites
- Install Node.js using the installer or a version manager such as nvm or fnm.
- Install
yarn
ornpm
to install dependencies. - Install dependencies with
yarn install
. - Register an account in the system this integration targets for ingestion and obtain API credentials.
cp .env.example .env
and add necessary values for runtime configuration.When an integration executes, it needs API credentials and any other configuration parameters necessary for fetching data from the provider. The names of these parameters are defined in
src/instanceConfigFields.ts
. When executed in a development environment, values for these parameters are read from Node'sprocess.env
, loaded from.env
. That file has been added to.gitignore
to avoid committing credentials.
Running the integration
yarn start
to collect datayarn graph
to show a visualization of the collected datayarn j1-integration -h
for additional commands
Making Contributions
Start by taking a look at the source code. The integration is basically a set of functions called steps, each of which ingests a collection of resources and relationships. The goal is to limit each step to as few resource types as possible so that should the ingestion of one type of data fail, it does not necessarily prevent the ingestion of other, unrelated data. That should be enough information to allow you to get started coding!
See the SDK development documentation for a deep dive into the mechanics of how integrations work.
See docs/development.md for any additional details about developing this integration.
Changelog
The history of this integration's development can be viewed at CHANGELOG.md.
Versioning this project
This project is versioned using auto.
Versioning and publishing to NPM are now handled via adding GitHub labels to pull requests. The following labels should be used for this process:
- patch
- minor
- major
- release
For each pull request, the degree of change should be registered by applying the appropriate label of patch, minor, or major. This allows the repository to keep track of the highest degree of change since the last release. When ready to publish to NPM, the PR should have both its appropriate patch, minor, or major label applied as well as a release label. The release label will denote to the system that we need to publish to NPM and will correctly version based on the highest degree of change since the last release, package the project, and publish it to NPM.
In order to successfully version and publish to NPM we need access to two secrets: a valid NPM token for publishing and a GitHub token for querying the repo and pushing version changes. For JupiterOne projects please put in a ticket with security to have the repository correctly granted access. For external projects, please provide secrets with access to your own NPM and GitHub accounts. The secret names should be set to NPM_AUTH_TOKEN and AUTO_GITHUB_PAT_TOKEN respectively (or the action can be updated to accomodate different naming conventions).
We are not currently using the functionality for auto to update the CHANGELOG. As such, please remember to update CHANGELOG.md with the appropriate version, date, and changes.
1 month ago
1 month ago
1 month ago
1 month ago
2 months ago
2 months ago
2 months ago
2 months ago
4 months ago
5 months ago
5 months ago
7 months ago
8 months ago
10 months ago
9 months ago
9 months ago
10 months ago
9 months ago
9 months ago
6 months ago
9 months ago
5 months ago
6 months ago
5 months ago
6 months ago
6 months ago
10 months ago
10 months ago
9 months ago
5 months ago
9 months ago
5 months ago
5 months ago
9 months ago
5 months ago
10 months ago
12 months ago
10 months ago
10 months ago
12 months ago
11 months ago
11 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago