Skip to content

FerrLabs/Changelog

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

52 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

FerrLabs Changelog

The editorial changelog for the FerrLabs developer toolkit — what we shipped, why, and how to use it. Renders at:

Each consumer site fetches this directory at build time via degit and filters by product. A repository_dispatch event fires every push to main and triggers a rebuild on every consumer.

Add an entry

Create entries/YYYY-MM-DD-<slug>.md:

---
title: 'Product · short headline'
summary: 'One sentence describing what shipped.'
date: 2026-04-29T15:30:00Z   # ISO 8601, time matters for ordering + datePublished
product: ferrflow              # ferrflow | ferrvault | ferrtrack | ferrgrowth | ferrfleet | ferrlens | ferrlabs
type: new                      # new | fix | perf | breaking | deprecation | security
prLink: https://github.com/... # optional
docsLink: https://...          # optional
---

3-10 sentences. **What** the change does, **why** we built it, **how** to use it.
Code blocks welcome — they get `translate="no"` automatically on the rendered pages.

When to add an entry

Always:

  • New user-facing feature (CLI flag, API endpoint, UI surface, config field).
  • Bug fix that affects existing users (behaviour change, error they'd have seen).
  • Performance improvement measurable from outside.
  • Breaking change (config rename, removed flag, default flip).
  • Deprecation (with the removal timeline).
  • Security fix (link the advisory).

Never:

  • Internal refactors with no external behaviour change.
  • Variable / function renames, type-only changes, code style.
  • CI / dev-tooling tweaks (unless visible to contributors).
  • Test-only changes.
  • Doc-only fixes (typos, broken links).
  • Dependency bumps that don't change behaviour.

Process

The PR shipping the user-facing change opens two PRs in parallel: one in the product repo, one here adding the changelog entry. Merge them in the same window so the entry goes live with the change.

License: MPL-2.0. Markdown only — keep it editorial, keep it short.

About

Public editorial changelog for the FerrLabs developer toolkit. Source of truth for ferrlabs.com/changelog and per-product changelog pages.

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors