@lerna/describe-ref is a utility package that helps in describing the current Git reference in a Lerna-managed monorepo. It provides information about the current Git branch, tag, or commit, which can be useful for versioning and release management in monorepos.

What are @lerna/describe-ref's main functionalities?

Describe the current Git reference

This feature allows you to get a description of the current Git reference, including branch name, tag, or commit hash. The `describeRef` function returns an object with details about the current Git state.

const { describeRef } = require('@lerna/describe-ref');

async function getGitRef() {
  const ref = await describeRef();
  console.log(ref);
}

getGitRef();

Custom base ref

This feature allows you to specify a custom base reference to compare against. The `describeRef` function can take an options object where you can set the `baseRef` to a specific branch or tag.

const { describeRef } = require('@lerna/describe-ref');

async function getCustomBaseRef(baseRef) {
  const ref = await describeRef({ baseRef });
  console.log(ref);
}

getCustomBaseRef('main');

Include distance from base ref

This feature includes the distance (number of commits) from the base reference in the description. The `includeDistance` option can be set to `true` to get this additional information.

const { describeRef } = require('@lerna/describe-ref');

async function getRefWithDistance() {
  const ref = await describeRef({ includeDistance: true });
  console.log(ref);
}

getRefWithDistance();

Other packages similar to @lerna/describe-ref

Changelog

Source

3.3.0 (2018-09-06)

Bug Fixes

describe-ref: Fallback refCount is the number of commits since beginning of repository (6dfea52)
Propagate exit codes from failed executions (af9c70b), closes #1374 #1653
run-lifecycle: Propagate exit code when execution fails (4763f95), closes #1495

Features

deps: Upgrade execa to ^1.0.0 (748ae4e)
deps: Upgrade fs-extra to ^7.0.0 (042b1a3)
deps: Upgrade get-stream to ^4.0.0 (e280d1d)
deps: Upgrade strong-log-transformer to ^2.0.0 (42b18a1)

Readme

Source

`@lerna/describe-ref`

Parse git describe output for lerna-related tags

Usage

const describe = require('@lerna/describe-ref');

(async () => {
  const { lastTagName, lastVersion, refCount, sha, isDirty } = await describe();
})();

// values listed here are their defaults
const options = {
  cwd: process.cwd(),
  // pass a glob to match tag name, e.g. "v*.*.*"
  match: undefined,
};

const {
  lastTagName,
  lastVersion,
  refCount,
  sha,
  isDirty,
} = describe.sync(options);

const result = describe.parse("v1.0.0-5-gdeadbeef");
// { lastTagName, lastVersion, refCount, sha, isDirty }

Keywords

FAQs

What is @lerna/describe-ref?

Is @lerna/describe-ref well maintained?

Last updated on 06 Sep 2018

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install