Skip to content

Commit

Permalink
Better changelog automation
Browse files Browse the repository at this point in the history
  • Loading branch information
julienbourdeau committed Feb 27, 2024
1 parent 14c7f16 commit f0022e4
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 34 deletions.
12 changes: 8 additions & 4 deletions bootstrap.php
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,10 @@
extends: _layouts.changelog
section: content
slug: changelog
title: Installation
subtitle: "Setup the Debugbar dev tools in your project"
seo_title:
seo_description:
title: Changelog
subtitle: "What's new in Debugbar?"
seo_title: "Rails Debugbar Changelog"
seo_description: "All new features, improvements and fixes in Debugbar and more importantly: all the breaking changes!"
---
TEXT;

Expand All @@ -42,6 +42,10 @@
File::put(__DIR__.'/source/changelog.blade.md', $content);
});

$events->afterBuild(function (Jigsaw $jigsaw) {
exec('git checkout -- '.__DIR__.'/source/changelog.blade.md');
});

$events->beforeBuild(function (Jigsaw $jigsaw) {
$manifest = json_decode(file_get_contents(__DIR__.'/source/assets/debugbar/manifest.json'), true);

Expand Down
32 changes: 2 additions & 30 deletions source/changelog.blade.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,2 @@
---
extends: _layouts.changelog
section: content
slug: changelog
title: Installation
subtitle: "Setup the Debugbar dev tools in your project"
seo_title:
seo_description:
---

## v0.2.0 - Unreleased

* Introduce polling in case someone cannot use ActiveCable - See [8b262be7](https://github.com/julienbourdeau/debugbar/commit/8b262be7b644c7b587a6c3348bb02076053a344f)
* https://debugbar.dev/docs/polling-mode
* Move main middleware higher in the chain - See [7ca51c10](https://github.com/julienbourdeau/debugbar/commit/7ca51c10c5999f7ad14a303c92083614551de134)
* Silence debugbar routes for quieter logs - See [efe491bd](https://github.com/julienbourdeau/debugbar/commit/efe491bde9e0544e5fb891597bb2af47854c1169)

### Breaking changes

The frontend configuration was slightly modified. If you customized the prefix for the debugbar routes or the channelName, you must update your config.
Prefix is at the root, and channelName is nested under the cable key.

```diff
- <%= debugbar_javascript channelName: "something_else", cable: {prefix: "custom-prefix"} %>
+ <%= debugbar_javascript prefix: "custom-prefix", cable: {channelName: "something_else"} %>
```

## v0.1.0 - 2024-02-13

* Initial release 🎉
This file generated before Build by pulling the changelog from GitHub.
Checkout bootstrap.php for the implementation.

0 comments on commit f0022e4

Please sign in to comment.