@scaleway/changesets-renovate/README.md

Automatically create changesets for Renovate and pnpm catalogs

# `@scaleway/changesets-renovate`

## Automatically create changesets for Renovate

## Install

```bash
$ pnpm add --global @scaleway/changesets-renovate
```

## Usage

This package is a very simple CLI:

```bash
changesets-renovate
```

To skip committing the changeset.

```bash
SKIP_COMMIT=TRUE changesets-renovate
```

To have a custom prefix for renovate branch name instead of `renovate/`

```bash
BRANCH_PREFIX=dep-upgrade changesets-renovate
```

To skip checking the branch name starts `renovate/`

```bash
SKIP_BRANCH_CHECK=TRUE changesets-renovate
```

To sort both the package bumps and update messages alphabetically

```bash
SORT_CHANGESETS=TRUE changesets-renovate
```

Example:

Unsorted:
```
---
'package-z': patch
'package-a': patch
---

Updated dependency `@company/zzz` to `0.228.0`.
Updated dependency `@company/aaa` to `1.1.15`.
Updated dependency `@company/zzz-backend` to `^0.228.0`.
```

Sorted:
```
---
'package-a': patch
'package-z': patch
---

Updated dependency `@company/aaa` to `1.1.15`.
Updated dependency `@company/zzz-backend` to `^0.228.0`.
Updated dependency `@company/zzz` to `0.228.0`.
```

It's inspired by this GitHub Action from Backstage: https://github.com/backstage/backstage/blob/master/.github/workflows/sync_renovate-changesets.yml