search

fastly / js-compute-runtime

JavaScript SDK and runtime for building Fastly Compute applications
https://developer.fastly.com/learning/compute/javascript/
Apache License 2.0
193 stars 26 forks source link

changelog: version links, disable checker for version links #780

Closed guybedford closed 1 month ago

guybedford commented 1 month ago

The release is currently failing because the CHANGELOG generation is outputting the version headings as URLs.

Release please seems to default to outputting the version headings as URLs now which seems useful as well.

This PR updates the existing CHANGELOG to use version heading URLs and also disables the changelog checker based on the assumption that we have enough evidence at this point to trust the output from release please.

In addition, the changelog checker doesn't seem to have an option to disable version URL checks.

For now this leaves the changelog checker in the repo in case we want to change this back in future, if it can support this or if we find a release please option to disable the version URL links (which I was unable to), but we could remove it entirely as well.

This PR should fix the current release at least.

JakeChampion commented 1 month ago

The checker ensures that the format is correct for consumption by the developer portal, the release-please format is not compatible unfortunately, I manually edit the changelog before each release to pass the checker, otherwise the RSS feed on developer portal will not get updates about our releases. Cc @doramatadora @kpfleming

guybedford commented 1 month ago

I did a revert here but unfortunately:

  1. This manual change is not documented anywhere in process
  2. Release please will not let me make manual changes to the release PR
  3. Manually creating a tag does not result in the release workflow running

I simply do not know how to create a release at this point.

The failed 3.14.2 release is not published, and sitting now on main. I will resolve this on Tuesday when I get back from holiday, unless someone else wants to look at it first or knows how to fix this further.

guybedford commented 1 month ago

To update on this: