Copy as Markdown[View as Markdown](/docs/sdk/functions/rmChangelog.md)

***

# Function: rmChangelog()

> **rmChangelog**(`catalogDir`): (`id`, `options`) => `Promise`<`void`>

Defined in: changelogs.ts:191

Removes the changelog for a resource in EventCatalog.

## Parameters[​](#parameters "Direct link to Parameters")

| Parameter    | Type     |
| ------------ | -------- |
| `catalogDir` | `string` |

## Returns[​](#returns "Direct link to Returns")

`Function`

### Parameters[​](#parameters-1 "Direct link to Parameters")

| Parameter          | Type                     |
| ------------------ | ------------------------ |
| `id`               | `string`                 |
| `options`          | { `version`: `string`; } |
| `options.version`? | `string`                 |

### Returns[​](#returns-1 "Direct link to Returns")

`Promise`<`void`>

## Example[​](#example "Direct link to Example")

```
import utils from '@eventcatalog/utils';

const { rmChangelog } = utils('/path/to/eventcatalog');

// Remove the changelog for a resource
await rmChangelog('OrderCreated');

// Remove the changelog for a specific version
await rmChangelog('OrderCreated', { version: '1.0.0' });
```
