Release documentation & publishing

Every release note,
approved before it's public.

DocPulse keeps the full internal record of every release: changes, documents, deployments and reviews. Your customers see only the notes a second person approved, on a public page you design for each product.

People to publish
2
Project roles
5
Page widgets
10

// Two records, one release

What your team knows. What your customers read.

Every change carries an internal description for the team and, optionally, a public one. Only changes with a public description can ever reach the public page, and only after approval.

  1. 01ProjectA product, its team, branding and public page
  2. 02ReleaseA version with type, channel and release date
  3. 03ChangesFeature, fix, security, performance and more
  4. 04RevisionA frozen copy of the public notes for approval
  5. 05SnapshotThe published page. It can't be edited, only revoked

// Publishing

Nothing goes public on one person's say-so.

The author freezes the public notes into a revision. Someone else approves exactly that revision, and an Admin or Release manager publishes it. Change a word afterwards and it needs a new revision.

  1. Draft
  2. Internal review
  3. Approval revision
  4. Approved
  5. Published
Step

Draft

Write the release and its changes. Internal notes stay internal.

Done by Developer Admin, Release manager or Developer

Self-approval is refused by the server, even for system administrators, and every decision is in the audit log.

// Public page designer

Each product gets its own release page.

Pick a theme, a layout and the widgets you want, preview it on desktop, tablet and mobile, then publish the design. Visitors only ever see the published version.

  • Ten widgets to show, hide and reorder, from hero to email sign-up
  • Three layouts: single column, sidebar right or sidebar left
  • Your colours and fonts, with live contrast checks
  • Draft, then publish, with every change in the audit log

// GitHub import

Bring your release history with you.

The importer reads a repository's GitHub releases and publishes them through the same approval flow. Four-part hotfix tags become proper versions, and pull-request titles are tidied into readable public notes.

GitHub tagDocPulse versionType
stable-3.1.03.1.0Minor
stable-3.2.03.2.0Minor
stable-3.2.0.13.2.0-hotfix.1Hotfix
stable-3.2.43.2.4Patch
One pull-request line

* feat/k4x9q2 dark mode for reports by @octo-dev in https://github.com/acme/web/pull/128

FeatureDark mode for reports

The author handle and link stay in the internal notes. The real GitHub release date is kept, and re-running the import skips what's already there. The importer script is in the source repository.

// Everything around the notes

The parts a release process actually needs.

Domains

Your own domain

Serve a product's release notes from its own domain, verified with a DNS record.

Follow

RSS and email

Readers subscribe by feed or by email, with double opt-in and one-click unsubscribe.

Languages

Translated notes

Publish a release in several languages. The page comes in English, Sinhala and Tamil.

Clients

Client-only notes

Share a release with chosen client groups instead of everyone.

Files

Scanned attachments

Release files are checked by a malware scanner before they can be made public.

Trace

Audit log

An append-only record of every change, approval and publication, exportable as CSV.

Connect

GitHub and deploys

GitHub App and signed webhooks link commits and deployments to releases.

Measure

Reader analytics

Page and release views without visitor tracking, with export for reports.

// Users & roles

The right person for each step.

Roles are set per project. System administrators manage everyone from one page, with one-time password links instead of shared passwords.

  • System admin
  • Admin
  • Release manager
  • Developer
  • Reviewer
  • Client

// Security

Public pages read approved snapshots only.

The public site can't see drafts or internal notes. Published snapshots can't be edited, only revoked.

  • Two-person approval
  • Immutable snapshots
  • Single sign-on (OIDC)
  • HttpOnly sessions
  • Rate-limited public API
  • Content Security Policy

// Setup

Running on your own server in five minutes.

DocPulse ships as four Docker images. One compose file starts them with PostgreSQL and Redis, and serves the release pages and the admin portal from a single port.

  1. 01 · Before you start

    Any Linux, macOS or Windows machine with Docker and Docker Compose v2 (included in current Docker Desktop and Docker Engine), and about 2 GB of free memory.

  2. 02 · Download the two files
    mkdir docpulse && cd docpulse
    curl -fsSLO https://qulaxy.com/DocPulse-Site/setup/docker-compose.yml
    curl -fsSL -o .env https://qulaxy.com/DocPulse-Site/setup/env.example
  3. 03 · Set the secrets

    Open .env and give POSTGRES_PASSWORD and the six secrets long random values. This fills them all in for you:

    for k in POSTGRES_PASSWORD JWT_ACCESS_SECRET BOOTSTRAP_SECRET WORKER_SECRET \
             NOTIFICATION_SECRET GITHUB_WEBHOOK_SECRET DEPLOYMENT_WEBHOOK_SECRET; do
      sed -i.bak "s|^$k=.*|$k=$(openssl rand -hex 32)|" .env
    done
  4. 04 · Start it
    docker compose up -d

    Open the admin portal at http://admin.localhost:8080, choose Create its first admin and enter the BOOTSTRAP_SECRET from .env. Release pages appear on http://localhost:8080. The first start takes a minute while the database is prepared.

// Your own domain

Point two names at the server, such as releases.example.com and admin.releases.example.com, and set PUBLIC_URL and ADMIN_URL in .env. Put HTTPS in front with your usual proxy, and list it in TRUSTED_PROXY_IPS.

// Updates

docker compose pull
docker compose up -d

Database changes apply automatically on start. Pin a version with DOCPULSE_VERSION in .env.

// Backups

docker compose exec postgres \
  pg_dump -U docpulse docpulse > backup.sql

Email delivery and malware scanning for attachments are optional and set in .env.

Built with

Ship release notes people can trust.

DocPulse is a KasunRocz Softwares project. The source code and the Docker images are public.