Skip to content
Simply SF logoSimply SF logoSimply Plugins Core

simply-cicd-core

Salesforce CI/CD pipeline stages (build, deploy, notify, sfdx-dependabot), ALM issue linking (Jira, GitLab Issues) and VCS API clients (GitHub, GitLab) — the library layer behind @simplysf/simply-cicd, published separately so it can be imported directly without pulling in the CLI framework. Full signatures and types are in the API reference.

Terminal window
npm install @simplysf/simply-cicd-core

Linking commits to ALM issues

Section titled “Linking commits to ALM issues”
import { createAlmProvider } from '@simplysf/simply-cicd-core';


const jira = createAlmProvider('jira');
const issues = jira.extractIssues(commitLog, ['PROJ']);
const { html } = jira.render(issues, 'https://example.atlassian.net/browse');

Talking to a VCS platform

Section titled “Talking to a VCS platform”
import { createVcsProvider } from '@simplysf/simply-cicd-core';


const gitlab = createVcsProvider('gitlab', { token: process.env.GITLAB_TOKEN });
const mr = await gitlab.findMergeRequest({ sourceBranch: 'feature/x' });

Running a pipeline stage without the CLI

Section titled “Running a pipeline stage without the CLI”

Every sf simply cicd stage is a function here that takes the camelCase equivalent of the command’s flags. Stages shell out to sf and git, so both must be on PATH.

import { deployProject } from '@simplysf/simply-cicd-core';


await deployProject({
  stage: 'install-packaged',
  alias: 'uat',
  ciJobToken: process.env.CI_JOB_TOKEN!,
  vcsProvider: 'gitlab',
  deployConfigFile: 'config/deploy.json',
});