feat(ng-dev/release): add marker between generated changelog entries

[josephperrott]

Adding a marker <!-- CHANGELOG SPLIT MARKER --> between changelog entries allows for easier
automated modification of the changelog file, for things like removing prerelease changelog entries
when publishing a new major, or automatically moving old changelog entries to an archive changelog.

Fixes #198

[devversion]

Nice! just a few comments/questions (especially because this logic will be core to all Angular repos)

[devversion]

I'm a bit unhappy about the reliance on some template-specifics here. It will become problematic if we make changes of the anchor. e.g. even when we switch from <a name to <a id (which is actually better for fragment resolution in w3c).

If you see my comment on moveEntriesPriorToVersionToArchive, an option is that we might not need the version at all, or alternatively we could incorporate the version in a specific comment that is generated here as part of the Changelog class (that keeps the logic more local and self-contained)

[josephperrott]

Should we include a metadata comment object? Something like.

<!--ReleaseMetadata {version: '1.2.3', name: 'release name'} -->

Then we can retrieve it with a regex and parse the results. We can then JSON.parse the matched content into something like Partial<ReleaseMetadata> where we have

interface ReleaseMetadata {
  version: string;
  name: string;
}


const metadataMatcher = RegExp(/<!--ReleaseMetadata.*(\{.*\})/);

for (const entry of entries) {
  const metadata = JSON.parse(entry.match(metadataMatcher)[1]) as Partial<ReleaseMetadata>;
}

There would need to be more validation/assertions I suppose, but this concept.

[devversion]

yeah, something around that is what I'd love to see. Could also be just something like:

<!-- ReleaseMetadata: Version|Name -->

Doesn't necessarily need to be JSON. I'm happy with either thing.

[josephperrott]

I think it makes sense to use JSON since it will make parsing easier. It won't be as whitespace sensitive and is easy to roll and unroll.

[devversion]

👍

[josephperrott]

Actually as I am looking at it now, I think it kind of ends up being a lot more change than we currently have to set this up, how do you feel about doing it in a follow up PR? It just feels like it ends up nearly unrelated to the current change.

[devversion]

sure, works for me!

[josephperrott]

Creating tracking issue at: #219

[angular-automatic-lock-bot]

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

_{This action has been performed automatically by a bot.}