@gitbeaker/core

What is @gitbeaker/core?

@gitbeaker/core is a comprehensive Node.js library for interacting with the GitLab API. It provides a wide range of functionalities to manage projects, repositories, issues, users, and more within a GitLab instance.

What are @gitbeaker/core's main functionalities?

Project Management

This feature allows you to create and manage projects within a GitLab instance. The code sample demonstrates how to create a new project using the GitLab API.

const { Gitlab } = require('@gitbeaker/node');
const api = new Gitlab({ token: 'your_access_token' });

async function createProject() {
  const project = await api.Projects.create({ name: 'new-project' });
  console.log(project);
}

createProject();

Issue Management

This feature allows you to create and manage issues within a GitLab project. The code sample demonstrates how to create a new issue in a specific project.

const { Gitlab } = require('@gitbeaker/node');
const api = new Gitlab({ token: 'your_access_token' });

async function createIssue() {
  const issue = await api.Issues.create(1, { title: 'New Issue', description: 'Issue description' });
  console.log(issue);
}

createIssue();

User Management

This feature allows you to manage users within a GitLab instance. The code sample demonstrates how to list all users using the GitLab API.

const { Gitlab } = require('@gitbeaker/node');
const api = new Gitlab({ token: 'your_access_token' });

async function listUsers() {
  const users = await api.Users.all();
  console.log(users);
}

listUsers();

Repository Management

This feature allows you to manage repositories and their contents within a GitLab project. The code sample demonstrates how to list all files in a repository.

const { Gitlab } = require('@gitbeaker/node');
const api = new Gitlab({ token: 'your_access_token' });

async function listRepositoryFiles() {
  const files = await api.Repositories.tree(1);
  console.log(files);
}

listRepositoryFiles();

Other packages similar to @gitbeaker/core

node-gitlab

node-gitlab is another Node.js library for interacting with the GitLab API. It provides similar functionalities to @gitbeaker/core but may have a different API design and feature set.

gitlab

gitlab is a simple Node.js wrapper for the GitLab API. It offers basic functionalities for interacting with GitLab but may not be as comprehensive as @gitbeaker/core.

node-gitlab-api

node-gitlab-api is a lightweight Node.js library for the GitLab API. It provides essential features for managing GitLab resources but may lack some advanced functionalities found in @gitbeaker/core.

README

^{My open source work is supported by the community}

^{Special thanks to:}

Review merge requests in Slack to merge code faster

_{Improve your code review process by creating an ephemeral channel per merge request.}

---

Core SDK for the GitLab API. This is not intended for direct use, see @gitbeaker/rest or gitbeaker/cli instead.

Table of Contents

• Usage
• Testing
• FAQ
• Contributors
• Changelog

Usage

Browsers	Load @gitbeaker/core directly from esm.sh <script type="module"> import { Gitlab } from 'https://esm.sh/@gitbeaker/core'; </script>
Deno	Load @gitbeaker/core directly from esm.sh import { Gitlab } from 'https://esm.sh/@gitbeaker/core?dts';
Node 18+	Install with npm install @gitbeaker/core, or yarn add @gitbeaker/core import { Gitlab } from '@gitbeaker/core';

Contributors

This started as a fork from node-gitlab-legacy but I ended up rewriting much of the code. Here are the original work's contributors.

Changelog

38.9.0 (Sun May 28 2023)

:tada: This release contains work from new contributors! :tada:

Thanks for all your work!

:heart: Roman Khristoforov (@ksilligan)

:heart: Bambii (@Bambii556)

🐛 Bug Fix

• @gitbeaker/core, @gitbeaker/rest
  • Updating CI Lint API Support to match Gitlab API v16 #3278 (@jdalrymple)
• @gitbeaker/core
  • Fix ExternalStatusChecks arguments #3276 (@ksilligan @jdalrymple)
  • Added fix for Group Access tokens requests #3275 ([e-mail] @Bambii556)

↕️ Dependencies

• Bump nx from 16.2.1 to 16.2.2 #3273 (@dependabot[bot])

📚 Documentation

• Add info about Node v16 support to FAQ #3277 (@jdalrymple)

Authors: 5

• @dependabot[bot]
• Bambii (@Bambii556)
• Justin Dalrymple (@jdalrymple)
• Roman Khristoforov (@ksilligan)
• Shaun Brown ([e-mail])

---