Folders and files
| Name | Name | Last commit date | ||
|---|---|---|---|---|
Publish a Nitrozen changelog entry straight from a GitHub Actions workflow — most commonly triggered by a GitHub Release.
name: Publish changelog
on:
release:
types: [published]
jobs:
changelog:
runs-on: ubuntu-latest
steps:
- uses: nitrozenio/changelog-action@v1
with:
api-key: ${{ secrets.NITROZEN_API_KEY }}
project-id: '123'When triggered by a release event, title and content default to the release's name/tag and body, so the snippet above is a complete integration on its own.
| Input | Required | Default | Description |
|---|---|---|---|
| api-key | yes | — | Nitrozen API token. Create one from your project's Settings → API Tokens page and store it as a repo/org secret. |
| project-id | yes | — | Numeric Nitrozen project ID. Find it via GET /api/v1/projects or your project dashboard URL. |
| title | no | release name/tag (on release events), else '' | Entry title. |
| content | no | release body (on release events), else '' | Entry body (Markdown supported). |
| category | no | new | Category slug. Built-in slugs: new, improvement, fix, announcement. Projects with custom categories enabled may have additional project-specific slugs. |
| is-published | no | true | true publishes immediately; false creates a draft for manual review. |
| published-at | no | now (when publishing) | ISO 8601 timestamp. Only applied when is-published is true. |
| project-slug | no | — | Project slug. Only used to build the changelog-url output. |
| api-base-url | no | https://nitrozen.io/api/v1 | Override for self-hosted or staging instances. |
| Output | Description |
|---|---|
| entry-id | ID of the created entry. |
| changelog-url | Public URL of the entry, e.g. https://nitrozen.io/c/payments-api/61 — only set when project-slug is provided. |
- uses: nitrozenio/changelog-action@v1
with:
api-key: ${{ secrets.NITROZEN_API_KEY }}
project-id: '123'
title: 'API v2.4.0'
content: |
- Added SSO authentication
- Fixed webhook retry bug
category: 'new'
is-published: 'false'- uses: nitrozenio/changelog-action@v1
id: nitrozen
with:
api-key: ${{ secrets.NITROZEN_API_KEY }}
project-id: '123'
project-slug: 'payments-api'
- run: echo "Published to ${{ steps.nitrozen.outputs.changelog-url }}"Examples in this README use @v1 for readability. v1 is a mutable tag — anyone with write access to this repo can move it. For workflows that handle secrets (this one takes NITROZEN_API_KEY), consider pinning to the full-length commit SHA of a specific release instead, with the version as a trailing comment so it stays human-readable:
- uses: nitrozenio/changelog-action@<40-char-commit-sha> # v1This is GitHub's own recommendation for any third-party action. Find the SHA for a given release on the Releases page or via git ls-remote --tags https://github.com/nitrozenio/changelog-action.
This is a composite action — it runs node publish.js using the Node runtime every GitHub-hosted runner already ships, with no npm install or build step. publish.js calls Nitrozen's public POST /projects/{project}/entries API (reference) with your token and inputs, and surfaces the created entry's ID (and optionally its URL) as step outputs.
node --test test/MIT