release: changelog generator + releaseregistry registration #6243

Chickensoupwithrice · 2024-12-03T00:52:00Z

This PR adds two more steps to the GHA release pipeline:

Generate a Changelog, and PR it
Register the release on the releaseregistry

Adding Cody to the releaseregistry allows us to integrate the changelog through that mechanism, but since no data is currently backported, we're using Git to determine previous release commit hashes in order to generate the new changelog.

Test plan

Run the CI pipeline 😬

Changelog

N/A

The changelog generator doesn't like overwriting existing files, so we write it to a different file and then append the old changelog to the newly generated file. Then we replace the old changelog with the new one. I tested this locally with the script (attached below for completeness). However in order to run the script, I built and copied the changelog generator from the devx service manually with Bazel, since the download only has binaries for linux. I came across a bug in the changelog generation where it doesn't accept the `github.token` flag when passed, but it will pick up the `GH_TOKEN` env var, so that's what I ended up using for testing. I _believe_ that this token is set by default in github actions, but am not certain. Test script: ``` PREV_TAG=$(git tag --sort=-v:refname | grep '^vscode-v' | head -n 2 | tail -n 1) RELEASE_LATEST_RELEASE=$(git rev-parse "$PREV_TAG") export RELEASE_LATEST_RELEASE export RELEASE_LATEST_COMMIT="1c6bc9563c39724e5248e0524017f41331f5bc64" export GH_TOKEN="CENSORED_REPLACE_ME_WITH_REAL_TOKEN" ./changelog write \ --output-file="new-changelog.md" \ --github.repo="sourcegraph/cody" \ --releaseregistry.version="1.48.0" cat vscode/CHANGELOG.md >>new-changelog.md mv new-changelog.md CHANGELOG.md ```

jdpleiness

Looks like there are still some merge conflicts and CI is still running for some reason? 🤔

jdpleiness · 2024-12-09T14:39:57Z

.github/workflows/vscode-stable-release.yml

+          cat vscode/CHANGELOG.md >> raw-changelog.md
+          mv raw-changelog.md vscode/CHANGELOG.md


Changelog generator doesn't do "prepend" to file for existing changelogs. We're doing that part by hand in the shell file.

can you provide a sample of what raw-changelog.md will look like?

maybe instead of appending the entire vscode/changelog.md into raw-changelog, we can find a spot within vscode/changelog.md and append under it

Example, this is what the current first 20 lines of vscode/changelog.md looks like:

# Changelog This is a log of all notable changes to Cody for VS Code. ## Unreleased ### Added ### Fixed ### Changed ### Uncategorized ## 1.50.0 ### Added - Webviews: add new CTA for Sourcegraph Teams [pull/6245](https://github.com/sourcegraph/cody/pull/6245) - "Explain command" in context (existing conversation) [pull/5986](https://github.com/sourcegraph/cody/pull/5986)

depending on what raw-changelog.md looks like, we could just append it right under ### uncategorized using

awk '/### Uncategorized/{if (!found) {print; system("cat raw_changelog.md"); found=1; next}} 1' vscode/CHANGELOG.md > temp_changelog.md # Replace original file with new content mv temp_changelog.md vscode/CHANGELOG.md

maybe we can pair on this to be clear!

jdpleiness · 2024-12-09T14:42:17Z

.github/workflows/vscode-stable-release.yml

+        run: |
+          echo "Registering internal cody-vscode $EXT_VERSION release on release registry"
+          body=$(wget --content-on-error -O- --header="Content-Type: application/json" --header="Authorization: ${RELEASE_REGISTRY_TOKEN}" --post-data '{
+              "name": "cody-vscode",


Do we have this type in the release registry already?

Nope, it's new!

Chickensoupwithrice · 2024-12-09T20:27:31Z

Yeah, CI on this repo is questionable, it's not expected to pass generally.

DaedalusG · 2024-12-12T05:46:25Z

.github/workflows/vscode-stable-release.yml

+          EXT_VERSION: ${{ env.EXT_VERSION }}
+        run: |
+          # Get previous tag's commit
+          PREV_TAG=$( git tag --sort=-v:refname | grep '^vscode-v' |  head -n 2 | tail -n 1)


Does this assume we've already registered our new release version? i.e.

vscode-v1.2.3
vscode-v1.2.2
vscode-v1.2.1
This would return 'vscode-v1.2.2'

Why are we selecting that one?

Hmm, for me this returns vscode-v1.46.0 which is currently the latest release, which is what we're trying to get. Once the releaseregistry is hooked up and has a bit of data, we can switch to using that

The list, without taking the second element exclusively, on my machine is:

kalanchan · 2024-12-12T06:22:55Z

will review this tomorrow, thanks for all the progress here my @sourcegraph/release boys 🫡

kalanchan

thank you so much @Chickensoupwithrice !!!! I left some comments, I think we should pull the changelog generator into a separate workflow.

i'll set up some time to pair with you to land this, but the direction is really good!

kalanchan · 2024-12-13T21:52:43Z

.github/workflows/vscode-stable-release.yml

+        env:
+          DEVX_SERVICE_GH_TOKEN: ${{ secrets.DEVX_SERVICE_GH_TOKEN }}
+          GH_REPO: "sourcegraph/cody"
+          CHANGELOG_CATEGORY_ACCEPTLIST: "added,changed,fixed"


if we leave this blank, will the tooling accept and group all categories?

.github/workflows/vscode-stable-release.yml

kalanchan · 2024-12-13T22:38:35Z

.github/workflows/vscode-stable-release.yml

+          cat vscode/CHANGELOG.md >> raw-changelog.md
+          mv raw-changelog.md vscode/CHANGELOG.md


can you provide a sample of what raw-changelog.md will look like?

maybe instead of appending the entire vscode/changelog.md into raw-changelog, we can find a spot within vscode/changelog.md and append under it

Example, this is what the current first 20 lines of vscode/changelog.md looks like:

# Changelog This is a log of all notable changes to Cody for VS Code. ## Unreleased ### Added ### Fixed ### Changed ### Uncategorized ## 1.50.0 ### Added - Webviews: add new CTA for Sourcegraph Teams [pull/6245](https://github.com/sourcegraph/cody/pull/6245) - "Explain command" in context (existing conversation) [pull/5986](https://github.com/sourcegraph/cody/pull/5986)

depending on what raw-changelog.md looks like, we could just append it right under ### uncategorized using

awk '/### Uncategorized/{if (!found) {print; system("cat raw_changelog.md"); found=1; next}} 1' vscode/CHANGELOG.md > temp_changelog.md # Replace original file with new content mv temp_changelog.md vscode/CHANGELOG.md

maybe we can pair on this to be clear!

.github/workflows/vscode-stable-release.yml

Chickensoupwithrice added 3 commits November 29, 2024 15:11

release: generate chanelog during release process

3818aa7

release: register releases on the releaseregistry

27c9007

Chickensoupwithrice marked this pull request as ready for review December 6, 2024 21:47

Chickensoupwithrice requested review from jdpleiness, DaedalusG and kalanchan December 6, 2024 21:47

jdpleiness reviewed Dec 9, 2024

View reviewed changes

Merge branch 'main' into al/rel/changelog-generator

b70f42d

Chickensoupwithrice requested a review from jdpleiness December 9, 2024 22:47

DaedalusG reviewed Dec 12, 2024

View reviewed changes

kalanchan requested changes Dec 13, 2024

View reviewed changes

split out changelog into it's own action

9095f2b

kalanchan mentioned this pull request Dec 27, 2024

chore/release: Remove the changelog section from the PR template. #6470

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

release: changelog generator + releaseregistry registration #6243

release: changelog generator + releaseregistry registration #6243

Chickensoupwithrice commented Dec 3, 2024

jdpleiness left a comment

jdpleiness Dec 9, 2024

Chickensoupwithrice Dec 9, 2024

kalanchan Dec 13, 2024

jdpleiness Dec 9, 2024

Chickensoupwithrice Dec 9, 2024

Chickensoupwithrice commented Dec 9, 2024

DaedalusG Dec 12, 2024

Chickensoupwithrice Dec 13, 2024

Chickensoupwithrice Dec 13, 2024

kalanchan commented Dec 12, 2024

kalanchan left a comment

kalanchan Dec 13, 2024

kalanchan Dec 13, 2024

		cat vscode/CHANGELOG.md >> raw-changelog.md
		mv raw-changelog.md vscode/CHANGELOG.md

release: changelog generator + releaseregistry registration #6243

Are you sure you want to change the base?

release: changelog generator + releaseregistry registration #6243

Conversation

Chickensoupwithrice commented Dec 3, 2024

Test plan

Changelog

jdpleiness left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Chickensoupwithrice commented Dec 9, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kalanchan commented Dec 12, 2024

kalanchan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment