Skip to content

Commit

Permalink
docs: add lumberjack 17 release notes (#204)
Browse files Browse the repository at this point in the history
## PR Checklist

Please check if your PR fulfills the following requirements:

- [ ] The commit message follows our guidelines: CONTRIBUTING.md#commit
- [ ] Tests for the changes have been added (for bug fixes / features)
- [x] Docs have been added / updated (for bug fixes / features)

## PR Type

What kind of change does this PR introduce?

<!-- Please check the one that applies to this PR using "x". -->

```
[ ] Bugfix
[ ] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[x] Documentation content changes
[ ] Other... Please describe:
```

## What is the current behavior?

We are ready to lunch but we haven't written the release notes for
version 17

Closes: #193 

## What is the new behavior?

The release notes for version 17 are ready to be published.

## Does this PR introduce a breaking change?

```
[ ] Yes
[x] No
```
  • Loading branch information
NachoVazquez authored Jan 31, 2024
1 parent 6d75549 commit e79f5a9
Showing 1 changed file with 71 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
---
title: 'Announcing Lumberjack v17: Literal Union Levels, Angular 17 and a new Contributor'
description: Lumberjack v17 is on as promised, here is what's new.
slug: announcing-lumberjack-v17
authors:
- name: Nacho Vazquez
title: NgWorker and core maintainer of Lumberjack
url: https://github.com/NachoVazquez
image_url: https://github.com/NachoVazquez.png
tags: [announcement, lumberjack, v16]
image: https://pub-2294738bc2c249ff8040505bf960c018.r2.dev/logo.svg
hide_table_of_contents: false
---

As promised, we are getting up to speed with Angular versions. We are happy to announce that Lumberjack v17 is here.

**TL;DR** - Lumberjack version 17 introduces the following: Support for string literal unions as log levels, deprecation of enum-based log levels, alignment with Angular 17 upgrading to the latest Nx, and a special new contributor.

## String Literal Unions Log Levels

In our continued pursuit of DX happiness, we are happy to introduce string literal unions as log levels.

String literal unions are less verbose than enums, and since they don't have a runtime implementation, they also make our bundle size lighter.

The new log levels are:

```ts
export type Level = 'critical' | 'debug' | 'error' | 'info' | 'trace' | 'verbose' | 'warn';
```

You can use the new API anywhere you were using the enum-based log levels:

Before:

```ts
this.#lumberjack.log({
level: LumberjackLevel.Info,
message: 'Hello, World!',
scope: 'MyComponent',
createdAt: this.#time.getUnixEpochTicks(),
});
```

Now:

```ts
this.#lumberjack.log({
level: 'info',
message: 'Hello, World!',
scope: 'MyComponent',
createdAt: this.#time.getUnixEpochTicks(),
});
```

## Enum-based Log levels deprecation

As part of the introduction to string literal unions, we are deprecating the enum-based log levels.

Once removed in version 19, we can reduce the bundle size and simplify the API.

## Community

On this version, we had the star collaboration of [Diego Julião](https://github.com/dianjuar) core maintainer of [ngx-deploy-npm](https://github.com/bikecoders/ngx-deploy-npm).

Diego helped us upgrade our deployment process to use the latest version of `ngx-deploy-npm`.

Thanks, Diego!

## Wrapping Up

That's it, folks. Last time, we promised to release a new version of Lumberjack quickly, and we did it. We are happy to be able to keep our promises. Now that we are up to date with Angular, you should expect more news on our [secret project](https://ngworker.github.io/lumberjack/blog/announcing-lumberjack-v16/#ambitious-secret-project) soon

0 comments on commit e79f5a9

Please sign in to comment.