Automate GitHub releases #61

leordev · 2023-10-30T22:19:15Z

This PR automates the trigger to create a GH Release when a changeset PR is merged.

Fix #60 (see full context context).

(Also it removes the TBDocs from the release pipeline because now we are planning to release default Typedoc similar to the DWN ones).

changeset-bot · 2023-10-30T22:19:19Z

⚠️ No Changeset found

Latest commit: 1683ff8

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

github-actions · 2023-10-30T22:24:20Z

TBDocs Report

✅ No errors or warnings

@tbdex/protocol

Project entry file: packages/protocol/src/main.ts

@tbdex/http-client

Project entry file: packages/http-client/src/main.ts

@tbdex/http-server

Project entry file: packages/http-server/src/main.ts

Updated @ 2023-10-30T22:29:04.701Z - Commit: 7471f75

KendallWeihe · 2023-10-31T13:13:34Z

.github/workflows/npm-publish.yml

@@ -25,59 +16,7 @@ permissions:
  id-token: write # necessary for NPM provenance

 jobs:
-  tbdocs-publish:


What's the plan with this?

keep using the reporter for our regular PRs (it will keep us in check regarding the missing docs and breaking api changes)

automatically publish the vanilla html generated by typedoc (similarly to dwn-sdk-js one)

we will link from the developer.tbd.website to this one, instead of publishing it there.

This is fruit of a conversation that I had with @ALRubinger and @mistermoe.

We agreed that developers will prefer to consume the API reference in their own ecosystem instead of getting used to the TBD website theming, which would probably have limitations compared to their natural tools. Think of javadoc for java, docs.rs for rust, pkg.go.dev for go developers and so on...

We started with js which has an ecosystem that most libs have their own website docs, so it was fine, but we are stepping back to a more standard approach, so that the website does not have embedded api references only for the js libs and the rest leaves outside... (cc @angiejones)

KendallWeihe · 2023-10-31T13:17:16Z

.github/workflows/create-gh-release.yml

+on:
+  pull_request:
+    types:
+      - closed


interesting terminology choice by GitHub here... to me "closed" is not the same as "merged"

KendallWeihe · 2023-10-31T13:18:15Z

this lgtm ✅

but I vote let's hold off until @mistermoe has a chance to look over, which may not be until next week

leordev · 2023-11-15T14:18:50Z

@KendallWeihe can I go ahead and merge now?

.github/workflows/create-gh-release.yml

KendallWeihe · 2023-11-15T14:38:16Z

@leordev I think we should add some material to the README which explains the way releases work, from the point of a developer opening a PR to the point where they can go to npmjs.com and see the new version

I wrote the Changesets section, but it's slightly misleading in that it's descriptive rather than prescriptive. I like what I've written, but it's a little daunting at first glance, and we may be better off to move it somewhere different and have a simple Release section which consists of an ordered list of steps

Open PR
changeset-bot will automatically comment (ex: pnpm and changesets #30 (comment)) on the PR with a reminder & recommendations for semver
Run pnpm changeset locally and push changes (.changet/*.md)
Merge PR into main
.github/workflows/create-gh-release.yml Will automatically create a GitHub Release
.github/workflows/npm-publish.yml Will automatically publish to NPM

Do I have it correct?

Have we had discussions around documenting release flows? Will release flows be standard across all implementations?

Co-authored-by: Kendall Weihe <kendallweihe@gmail.com>

leordev · 2023-11-30T22:22:01Z

@KendallWeihe

Do I have it correct?

Yes!

I think we should add some material to the README which explains the way releases work, from the point of a developer opening a PR to the point where they can go to npmjs.com and see the new version

Done! Check it out: 10a74e1#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5

Have we had discussions around documenting release flows? Will release flows be standard across all implementations?

Not yet, we do have this issue to capture that! And I agree that we should converge into a standard for all implementations. Although each language will have its own toolset.

@mistermoe @KendallWeihe about this step: Run pnpm changeset locally and push changes (.changet/*.md) -- should the developer ALWAYS do that for EVERY PR? Or only for PRs that they intend to release a new version? If the former, each merge to main will derive a new release. Is that the intent?

KendallWeihe · 2023-12-01T11:55:15Z

I still didn't love my wording, specifically this bit,

Whereafter, a pnpm changeset version command must be executed.

...which makes it sound like the developer must execute this step.

I took the liberty of adjusting things a bit further 098c1e4 @leordev what'd you think? Feel free to adjust/undo/whatevs.

jiyoonie9 · 2023-12-01T15:32:18Z

.github/workflows/create-gh-release.yml

+# we want to allow these release deployments to complete.
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: false


is there a chance that a deployment can hang, in which we'd want to cancel in progress?

jiyoonie9 · 2023-12-01T15:34:05Z

.github/workflows/npm-publish.yml

@@ -4,15 +4,6 @@ on:
  release:
    types: [created]
  workflow_dispatch:
-    inputs:


could you give me some context on why this block has been removed?

Since there's no more docs publishing in the release process it does not make sense to have these options anymore!

leordev requested review from michaelneale, mistermoe, jiyoonie9, phoebe-lew and KendallWeihe as code owners October 30, 2023 22:19

leordev force-pushed the leordev/automate-gh-release branch from 1d6c2e2 to 83fce59 Compare October 30, 2023 22:22

leordev force-pushed the leordev/automate-gh-release branch from 83fce59 to a107733 Compare October 30, 2023 22:27

KendallWeihe reviewed Oct 31, 2023

View reviewed changes

KendallWeihe reviewed Nov 15, 2023

View reviewed changes

.github/workflows/create-gh-release.yml Outdated Show resolved Hide resolved

Automate GitHub releases

6d9dd7e

leordev force-pushed the leordev/automate-gh-release branch from a107733 to 6d9dd7e Compare November 30, 2023 21:39

leordev and others added 2 commits November 30, 2023 16:42

Update .github/workflows/create-gh-release.yml

a828e8c

Co-authored-by: Kendall Weihe <kendallweihe@gmail.com>

Document Release

10a74e1

leordev force-pushed the leordev/automate-gh-release branch from ad44caf to 10a74e1 Compare November 30, 2023 22:18

leordev requested a review from KendallWeihe November 30, 2023 22:22

Reword Changesets description to have clearer expectations

098c1e4

KendallWeihe approved these changes Dec 1, 2023

View reviewed changes

jiyoonie9 reviewed Dec 1, 2023

View reviewed changes

jiyoonie9 approved these changes Dec 1, 2023

View reviewed changes

test-release

ed5c22a

leordev force-pushed the leordev/automate-gh-release branch from 0e2d089 to ed5c22a Compare December 4, 2023 20:30

release config final

1683ff8

leordev merged commit 32e8b82 into main Dec 4, 2023
8 checks passed

leordev deleted the leordev/automate-gh-release branch December 4, 2023 20:37

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Automate GitHub releases #61

Automate GitHub releases #61

leordev commented Oct 30, 2023 •

edited

Loading

changeset-bot bot commented Oct 30, 2023 •

edited

Loading

github-actions bot commented Oct 30, 2023 •

edited

Loading

KendallWeihe Oct 31, 2023

leordev Nov 2, 2023

KendallWeihe Oct 31, 2023

KendallWeihe commented Oct 31, 2023

leordev commented Nov 15, 2023

KendallWeihe commented Nov 15, 2023 •

edited

Loading

leordev commented Nov 30, 2023

KendallWeihe commented Dec 1, 2023

jiyoonie9 Dec 1, 2023

jiyoonie9 Dec 1, 2023

leordev Dec 1, 2023

Automate GitHub releases #61

Automate GitHub releases #61

Conversation

leordev commented Oct 30, 2023 • edited Loading

changeset-bot bot commented Oct 30, 2023 • edited Loading

⚠️ No Changeset found

github-actions bot commented Oct 30, 2023 • edited Loading

@tbdex/protocol

@tbdex/http-client

@tbdex/http-server

KendallWeihe Oct 31, 2023

Choose a reason for hiding this comment

leordev Nov 2, 2023

Choose a reason for hiding this comment

KendallWeihe Oct 31, 2023

Choose a reason for hiding this comment

KendallWeihe commented Oct 31, 2023

leordev commented Nov 15, 2023

KendallWeihe commented Nov 15, 2023 • edited Loading

leordev commented Nov 30, 2023

KendallWeihe commented Dec 1, 2023

jiyoonie9 Dec 1, 2023

Choose a reason for hiding this comment

jiyoonie9 Dec 1, 2023

Choose a reason for hiding this comment

leordev Dec 1, 2023

Choose a reason for hiding this comment

leordev commented Oct 30, 2023 •

edited

Loading

changeset-bot bot commented Oct 30, 2023 •

edited

Loading

github-actions bot commented Oct 30, 2023 •

edited

Loading

KendallWeihe commented Nov 15, 2023 •

edited

Loading