Release Notes and Changelogs
Summary
How we do our changelog and release notes at Dendron.
Concepts
Changelog
With every release, the Changelog (Private) expands to include the following types of updates (with docs links, when applicable):
- Features
- Enhancements
- Fixes
- Breaking Changes
- Deprecation Notices
Highlights
The first sections of any release notes will contain an overview highlighting specific features and enhancements of a release.
This is made up of:
- Overview of features, enhancements, and/or breaking changes of importance in the release.
## Highlights
: Changelog items referenced in the overview.## Everything Else
: Changelog items not referenced in the overview.
Early Seed
These are pre-release versions of Dendron extensions made available to Environmentalist (Private).
- Release cadence: Every Other Tuesday (PST)
Release Notes
Release notes are done with the General Release of Dendron that comes out each Tuesday. These provide quite a bit more context compared to the changelog notes, including:
- Highlights
- Upcoming events
- Discord community messages from the today-i-learned (Private) and starboard (Private) channels
- Community contributions: Contributors that have been raising issues, contributing code, contributing docs, etc. For more information, view the documentation on Discord Roles (Private)
- General announcements: Blog posts, videos, other events/resources of note, etc.
The release notes also serve as the content submitted to subscribers of the Dendron Newsletter.
Newsletter
Dendron sends out a weekly newsletter, scheduled for every Wednesday at 6AM PST.
Dendron uses Buttondown for managing a newsletter. It's a simple interface that uses Markdown formatting. To make our lives easier, we use a newsletter template and the Markdown Export Pod to send subscribers a copy of our weekly release notes.
Details
Dendron releases twice a week:
- Early Seed Release (pre-release): Every Friday
- Release (general availability / GA release): Every Tuesday
SOPs
- Changelog Update
- Reading Series
- Release Highlights
- Early Seed Release: Docs
- Weekly Release Notes
- Weekly Newsletter
- Social Media
Templates
- Reading Series: Discord Template
- Release Highlights: Template
- Newsletter Template
- Early Seed: Team Discord Thread Start
- Early Seed: Discord Announcement for Environmentalists
- General/Weekly Release: Discord Thread Start
Children