Openchangelog

https://openchangelog.com/docs
Admin
Openchangelog is a platform for creating, managing, and publishing changelogs with support for...
Tokens:2,480
Snippets:44
Trust Score:6.6
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install Openchangelog Package

Source: https://openchangelog.com/docs/sdks/next

Use your preferred package manager to add the dependency to your project.

```bash
npm install @openchangelog/next
# or
yarn add @openchangelog/next
# or
pnpm add @openchangelog/next
```

--------------------------------

### Example Conventional Commits

Source: https://openchangelog.com/docs/getting-started/conventional-commits

These examples demonstrate the structure of Conventional Commits for features and fixes.

```gitcommit
feat: allow provided config object to extend other configs
```

```gitcommit
feat(api)!: send an email to the customer when a product is shipped
```

```gitcommit
fix: prevent racing of requests
```

--------------------------------

### Defining Tags in Frontmatter

Source: https://openchangelog.com/docs/getting-started/writing-release-notes

Example of assigning a list of tags to a release note within the YAML frontmatter block.

```yaml
tags:
  - Feature
  - Security
  - Improvement
```

--------------------------------

### Markdown Code Block Syntax

Source: https://openchangelog.com/docs/getting-started/writing-release-notes

Example of a JavaScript code block with syntax highlighting using triple backticks.

```javascript
// Javascript code with syntax highlighting.
var fun = function lang(l) {
  dateformat.i18n = require('./lang/' + l);
  return true;
};
```

--------------------------------

### Deploy Openchangelog with Docker

Source: https://openchangelog.com/docs/getting-started/self-hosting

Commands and configuration files to run Openchangelog in a containerized environment.

```bash
docker run -v ./openchangelog.yml:/etc/openchangelog.yml:ro -v ./release-notes:/release-notes -p 6001:6001 ghcr.io/jonashiltl/openchangelog:0.6.2
```

```yaml
services:
  openchangelog:
    image: "ghcr.io/jonashiltl/openchangelog:0.6.2"
    ports:
      - "6001:6001"
    volumes:
      - ./release-notes:/release-notes
      - type: bind
        source: openchangelog.yml
        target: /etc/openchangelog.yml
```

--------------------------------

### Minimal openchangelog.yml configuration

Source: https://openchangelog.com/docs/getting-started/self-hosting

A basic configuration file defining the server address and local file path for release notes.

```yaml
addr: 0.0.0.0:6001
local:
  filesPath: /release-notes
page:
  title: Changelog
  subtitle: The latest product updates
  colorScheme: light
  hidePoweredBy: false
  logo:
    src: https://openchangelog.com/logo-full.webp
    link: https://www.openchangelog.com
```

--------------------------------

### Configure Caching

Source: https://openchangelog.com/docs/getting-started/self-hosting

Set up disk-based caching to improve performance and avoid API rate limits.

```yaml
cache:
  type: disk
  disk:
    location: /data/cache
    maxSize: 1073741824 # 1 GB in bytes
  # s3:
  #  bucket: the bucket url, env AWS_ACCESS_KEY_ID and AWS_SECRET_KEY are used as credentials
```

--------------------------------

### Enable Password Authentication

Source: https://openchangelog.com/docs/getting-started/self-hosting

Protect the changelog by setting a bcrypt password hash.

```yaml
page:
  auth:
    enabled: true
    # passwordHash: bcrypt hash of password
```

--------------------------------

### Configure GitHub in openchangelog.yml

Source: https://openchangelog.com/docs/sources/github

Add the github section to your configuration file to define the repository path and authentication method.

```yaml
github:
  owner:
  repo:
  path:                 # to file or folder
  auth:
    accessToken:        # access token with a access to the specified repo
    # or
    appPrivateKey:      # path to private key
    appInstallationId:
```

--------------------------------

### Enable Full Text Search

Source: https://openchangelog.com/docs/getting-started/self-hosting

Configure search indexing using disk or memory storage.

```yaml
search:
  type: disk # or memory
  disk:
    path: /data/search
```

--------------------------------

### Configure Local Release Notes Path

Source: https://openchangelog.com/docs/sources/local

Specify the path to your changelog file or folder containing release notes in the 'openchangelog.yml' configuration file. This enables local storage for your release notes.

```yaml
local:
  filesPath: /release-notes
```

--------------------------------

### Release Note Filename Convention

Source: https://openchangelog.com/docs/getting-started/writing-release-notes

Recommended naming pattern for release note files to ensure correct chronological sorting.

```text
{version}.{title}.md
v0.0.1.darkmode.md
v0.0.2.i81n.md
```

--------------------------------

### Configure Page Appearance

Source: https://openchangelog.com/docs/getting-started/self-hosting

Settings for customizing the changelog title, subtitle, color scheme, and logo.

```yaml
page:
  title: Changelog
```

```yaml
page:
  subtitle: Here is a rundown of the latest updates and improvements to ...
```

```yaml
page:
  colorScheme: light
```

```yaml
page:
  logo:
    src: https://openchangelog.com/logo-full.webp   # required to display a logo
    alt: our logo                                   # optional
    width: 70px                                     # optional
    height: 30px                                     # optional
    link: https://openchangelog.com                 # optional
```

--------------------------------

### Configure Tinybird Analytics

Source: https://openchangelog.com/docs/getting-started/self-hosting

Set up analytics tracking by providing a Tinybird access token.

```yaml
analytics:
  provider: tinybird
  tinybird:
    accessToken: ...
```

--------------------------------

### Embed Changelog Component

Source: https://openchangelog.com/docs/sdks/next

Import the Changelog server component and configure it with your workspace and changelog IDs.

```tsx
import { Changelog } from "@openchangelog/next"


export default function Page() {
  return (
    <Changelog
      workspaceID="ws_xxxx"  // when using Openchangelog cloud
      changelogID="cl_xxxx"  // when using Openchangelog cloud
      theme="dark"           // or light
    />
  );
}
```
Tokens:
Raw