Repository navigation
Add changelogs to modules - #2300
Merged
Merged
Conversation
Contributor
🔍 Suggested ReviewersBased on git blame analysis of the changed lines, the following contributors have significant experience with the modified code:
Please consider reviewing this PR as you have authored significant portions of the code being modified. Your expertise would be valuable! 🙏 This comment was automatically generated by git-blame-auto-reviewer Last updated: 2025-11-24T16:25:02.776Z |
Deploying devenv with
|
| Latest commit: |
7921e7d
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://48373c7f.devenv.pages.dev |
| Branch Preview URL: | https://changelogs.devenv.pages.dev |
domenkozar
force-pushed
the
changelogs
branch
3 times, most recently
from
November 24, 2025 00:02
e614603 to
d2eb73f
Compare
Introduces a changelog system that displays release notes and
important updates to users after running `devenv update`.
Changelogs are defined using the `changelogs` option in any devenv.nix
module or configuration:
```nix
{
changelogs = [
{
date = "2025-01-15";
title = "git-hooks.package is now pkgs.prek";
when = config.git-hooks.enable;
description = ''
Some markdown description of the change
'';
}
];
}
```
Each entry requires:
- `date`: A YYYY-MM-DD formatted date string
- `title`: Short description of the change
- `when`: Condition for including the changelog (e.g., based on config)
- `description`: Markdown-formatted detailed description
The hash is computed from date and title only, allowing descriptions
to be amended without affecting deduplication. Shown changelogs are
cached in `.devenv/changelog-cache.json`.
A new `devenv changelogs` command displays all relevant changelogs.
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>
domenkozar
force-pushed
the
changelogs
branch
from
November 24, 2025 14:28
d2eb73f to
0e7453e
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Introduces a changelog system that displays release notes and
important updates to users after running
devenv update.Changelogs are defined using the
changelogsoption in any devenv.nixmodule or configuration:
Each entry requires:
date: A YYYY-MM-DD formatted date stringtitle: Short description of the changewhen: Condition for including the changelog (e.g., based on config)description: Markdown-formatted detailed descriptionThe hash is computed from date and title only, allowing descriptions
to be amended without affecting deduplication. Shown changelogs are
cached in
.devenv/changelog-cache.json.A new
devenv changelogscommand displays all relevant changelogs.🤖 Generated with Claude Code
Co-Authored-By: Claude noreply@anthropic.com