f3ath/change

Changelog manipulation for Dart

change

Changelog manipulation in Dart. For the command-line tool, see Cider.

Features

• Supports basic Markdown syntax, such as bold, italic, links, etc.
• CRUD operations on releases and changes.

Limitations

• Works with changelogs following keepachangelog format only.
• Semantic versioning is implied.
• Dates must be in ISO 8601 (YYYY-MM-DD) format.
• Complex Markdown (e.g. tables, nested lists, HTML, etc) will not work. For better markdown support consider opening a PR to marker.

Example

import 'dart:io';

import 'package:change/change.dart';

/// This example shows how to parse a changelog.
/// Run it from the project root folder: `dart example/main.dart`
void main() {
  final file = File('CHANGELOG.md');
  final log = parseChangelog(file.readAsStringSync());
  final latest = log.history().last;
  print('Changelog contains ${log.history().length} releases.');
  print('The latest version is ${latest.version}');
  print('released on ${latest.date}');
  print('and containing ${latest.changes().length} change(s).');
}

change's Issues

PathNotFoundException in Flutter App

By following official doc in change package, I've added CHANGELOG.md file in root directory.
When i try in a Elevated button onTap function

import 'dart:io';
import 'package:change/change.dart';
import 'package:flutter/material.dart';
..........
ListTile(
            leading: const Icon(LucideIcons.sparkles),
            title: const Text('Changelog'),
            onTap: ()  {
              final file = File('CHANGELOG.md');
              final log = parseChangelog(file.readAsStringSync());
              final latest = log.history().last;
              debugPrint(
                  'Changelog contains ${log.history().length} releases.');
              debugPrint('The latest version is ${latest.version}');
              debugPrint('released on ${latest.date}');
              debugPrint(
                  'and containing ${latest.changes().length} change(s).');
            },
          ),
..........

Error log says that I/flutter (19066): PathNotFoundException: Cannot open file, path = 'CHANGELOG.md' (OS Error: No such file or directory, errno = 2)

So, how to solve this error?

Allow keeping freetext release notes

I like adding freetext to my release notes to summarize the technical added/fixed sections for technical less versed user, as shown below. Unfortunately cider release strips these sections upon rewriting the file.

## [1.1.0] - 2023-06-07
Install immediately, super important bug fix
### Fixed
 - xyz
## [1.1.0] - 2023-06-07
Massive performance increase
### Added
 - blah
 - blub
## [1.0.0] - 2023-06-07
This release stabalized everything, the api is now considered feature complete.
### Added
- Minimum viable product release

Support omitting the section header

(it would also be really really nice if describe allowed getting only the body, without the title and the link at the end. perhaps as an optional flag. but maybe thats better for another issue)

Originally posted by @clragon in f3ath/cider#48 (comment)

About "Unreleased" header

Does the "Unreleased" header need to be present even when its content is empty?

Web support - example does not work

Hello,

When using it for the web following the example I get the error "Unsupported operation: _Namespace"