{"id":13929061,"url":"https://github.com/JupiterOne-Archives/graph-gitlab","last_synced_at":"2025-07-19T10:32:47.565Z","repository":{"id":41966383,"uuid":"259399773","full_name":"JupiterOne/graph-gitlab","owner":"JupiterOne","description":"A graph conversion tool for https://gitlab.com","archived":false,"fork":false,"pushed_at":"2024-07-22T17:18:16.000Z","size":1486,"stargazers_count":2,"open_issues_count":10,"forks_count":6,"subscribers_count":11,"default_branch":"main","last_synced_at":"2024-07-23T17:45:05.463Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/JupiterOne.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-04-27T17:12:33.000Z","updated_at":"2024-07-23T17:45:05.464Z","dependencies_parsed_at":"2024-05-17T16:32:17.159Z","dependency_job_id":"5fb0644a-0068-496d-93c3-12fa0723952d","html_url":"https://github.com/JupiterOne/graph-gitlab","commit_stats":null,"previous_names":[],"tags_count":65,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JupiterOne%2Fgraph-gitlab","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JupiterOne%2Fgraph-gitlab/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JupiterOne%2Fgraph-gitlab/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JupiterOne%2Fgraph-gitlab/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JupiterOne","download_url":"https://codeload.github.com/JupiterOne/graph-gitlab/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":214386290,"owners_count":15725573,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-07T18:02:05.158Z","updated_at":"2024-11-26T17:31:20.240Z","avatar_url":"https://github.com/JupiterOne.png","language":"TypeScript","funding_links":[],"categories":["others"],"sub_categories":[],"readme":"# JupiterOne Integration\n\nLearn about the data ingested, benefits of this integration, and how to use it\nwith JupiterOne in the [integration documentation](docs/jupiterone.md).\n\n## Development\n\n### Prerequisites\n\n1. Install [Node.js](https://nodejs.org/) using the\n   [installer](https://nodejs.org/en/download/) or a version manager such as\n   [nvm](https://github.com/nvm-sh/nvm) or [fnm](https://github.com/Schniz/fnm).\n2. Install [`yarn`](https://yarnpkg.com/getting-started/install) or\n   [`npm`](https://github.com/npm/cli#installation) to install dependencies.\n3. Install dependencies with `yarn install`.\n4. Register an account in the system this integration targets for ingestion and\n   obtain API credentials.\n5. `cp .env.example .env` and add necessary values for runtime configuration.\n\n   When an integration executes, it needs API credentials and any other\n   configuration parameters necessary for its work (provider API credentials,\n   data ingestion parameters, etc.). The names of these parameters are defined\n   by the `IntegrationInstanceConfigFieldMap`in `src/config.ts`. When the\n   integration is executed outside the JupiterOne managed environment (local\n   development or on-prem), values for these parameters are read from Node's\n   `process.env` by converting config field names to constant case. For example,\n   `clientId` is read from `process.env.CLIENT_ID`.\n\n   The `.env` file is loaded into `process.env` before the integration code is\n   executed. This file is not required should you configure the environment\n   another way. `.gitignore` is configured to avoid committing the `.env` file.\n\n### Running the integration\n\n#### Running directly\n\n1. `yarn start` to collect data\n2. `yarn graph` to show a visualization of the collected data\n3. `yarn j1-integration -h` for additional commands\n\n#### Running with Docker\n\nCreate an integration instance for the integration in JupiterOne. With an\n**JupiterOne API Key** scoped to the integration or an API Key with permissions\nto synchronize data and the **Integration Instance ID**:\n\n1. `docker build -t $IMAGE_NAME .`\n2. `docker run -e \"JUPITERONE_API_KEY=\u003cJUPITERONE_API_KEY\u003e\" -e \"JUPITERONE_ACCOUNT=\u003cJUPITERONE_ACCOUNT\u003e -e \"INTEGRATION_INSTANCE_ID=\u003cINTEGRATION_INSTANCE_ID\u003e\" \"JUPITERONE_API_BASE_URL=\u003cJUPITERONE_API_BASE_URL\u003e\" $IMAGE_NAME`\n\n### Making Contributions\n\nStart by taking a look at the source code. The integration is basically a set of\nfunctions called steps, each of which ingests a collection of resources and\nrelationships. The goal is to limit each step to as few resource types as\npossible so that should the ingestion of one type of data fail, it does not\nnecessarily prevent the ingestion of other, unrelated data. That should be\nenough information to allow you to get started coding!\n\nSee the\n[SDK development documentation](https://github.com/JupiterOne/sdk/blob/main/docs/integrations/development.md)\nfor a deep dive into the mechanics of how integrations work.\n\nSee [docs/development.md](docs/development.md) for any additional details about\ndeveloping this integration.\n\n## Testing the integration\n\nIdeally, all major calls to the API and converter functions would be tested. You\ncan run the tests with `yarn test`, and you can run the tests as they execute in\nthe CI/CD environment with `yarn test:ci` (adds linting and type-checking to\n`yarn test`). If you have a valid runtime configuration, you can run the tests\nwith your credentials using `yarn test:env`.\n\nFor more details on setting up tests, and specifically on using recordings to\nsimulate API responses, see `test/README.md`.\n\n### Changelog\n\nThe history of this integration's development can be viewed at\n[CHANGELOG.md](CHANGELOG.md).\n\n## Versioning this project\n\nThis project is versioned using [auto](https://intuit.github.io/auto/).\n\nVersioning and publishing to NPM are now handled via adding GitHub labels to\npull requests. The following labels should be used for this process:\n\n- patch\n- minor\n- major\n- release\n\nFor each pull request, the degree of change should be registered by applying the\nappropriate label of patch, minor, or major. This allows the repository to keep\ntrack of the highest degree of change since the last release. When ready to\npublish to NPM, the PR should have both its appropriate patch, minor, or major\nlabel applied as well as a release label. The release label will denote to the\nsystem that we need to publish to NPM and will correctly version based on the\nhighest degree of change since the last release, package the project, and\npublish it to NPM.\n\nIn order to successfully version and publish to NPM we need access to two\nsecrets: a valid NPM token for publishing and a GitHub token for querying the\nrepo and pushing version changes. For JupiterOne projects please put in a ticket\nwith security to have the repository correctly granted access. For external\nprojects, please provide secrets with access to your own NPM and GitHub\naccounts. The secret names should be set to NPM_AUTH_TOKEN and\nAUTO_GITHUB_PAT_TOKEN respectively (or the action can be updated to accommodate\ndifferent naming conventions).\n\nWe are not currently using the functionality for auto to update the CHANGELOG.\nAs such, please remember to update CHANGELOG.md with the appropriate version,\ndate, and changes.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FJupiterOne-Archives%2Fgraph-gitlab","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FJupiterOne-Archives%2Fgraph-gitlab","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FJupiterOne-Archives%2Fgraph-gitlab/lists"}