chore: add `pkg.pr.new` #6362

userquin · 2024-08-19T14:39:52Z

Description

This PR includes:

~~update PR template to include /publish tip~~
~~add CR comment workflow via /publish (tip on the PR template)~~
add CR workflow to use cr-tracked label PR or main branch push
release all packages: we can add one workflow per package releasing only the corresponding one

This PR requires:

create a cr-tracked label
add pkg-pr-new app to vitest package
add CR_PAT secret to Actions with a token with public_repo (Classic Token): later we can automate it with something like this https://github.com/vitest-dev/vitest/blob/main/.github/workflows/ecosystem-ci-trigger.yml#L63C1-L68 (I'm a newbye on GH actions/webflows)

This PR requires also a review to exclude CR for docs for example, we can use something like this in on.pull_request:

    paths-ignore:
      - '.github/**'
      - 'test/**'
      - 'examples/**'      
      - 'docs/**'
      - '*.md'

/cc @Aslemammad

Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

It's really useful if your PR references an issue where it is discussed ahead of time. If the feature is substantial or introduces breaking changes without a discussion, PR might be closed.
Ideally, include a test that fails without this PR but passes with it.
Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Tests

Run the tests with pnpm test:ci.

Documentation

If you introduce new functionality, document it. You can run documentation with pnpm run docs command.

Changesets

Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.

netlify · 2024-08-19T14:42:41Z

✅ Deploy Preview for vitest-dev ready!

Name	Link
🔨 Latest commit	`094916a`
🔍 Latest deploy log	https://app.netlify.com/sites/vitest-dev/deploys/66fb3863210ac1000801e7bd
😎 Deploy Preview	https://deploy-preview-6362--vitest-dev.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Aslemammad · 2024-08-19T17:31:39Z

.github/workflows/cr-comment.yml

+    runs-on: ubuntu-latest
+
+    steps:
+      - run: gh issue edit ${{ github.event.issue.number }} --add-label cr-tracked --repo ${{ github.repository }}


hmm, what is this for?

will add the cr-tracked label once received /publish PR comment, check vite-pwa/vite-plugin-pwa#742

ohhh, makes sense! Thank you so much!

Aslemammad · 2024-08-19T18:13:40Z

I love this.

.github/PULL_REQUEST_TEMPLATE.md

.github/workflows/cr.yml

hi-ogawa · 2024-09-26T10:08:38Z

@userquin We discussed about how to trigger pkg.pr.new and we agreed "cr-tracked" label based workflow is okay. I'll push a few commits here and see how it goes.

hi-ogawa · 2024-09-26T10:10:01Z

@sheremet-va We haven't installed the app yet? https://github.com/vitest-dev/vitest/actions/runs/11050071341/job/30697038656?pr=6362#step:7:13

{"url":"/check","statusCode":404,"statusMessage":"Not Found","message":"The app https://github.com/apps/pkg-pr-new is not installed on vitest-dev/vitest."}

sheremet-va · 2024-09-26T10:11:40Z

@sheremet-va We haven't installed the app yet? vitest-dev/vitest/actions/runs/11050071341/job/30697038656?pr=6362#step:7:13
{"url":"/check","statusCode":404,"statusMessage":"Not Found","message":"The app https://github.com/apps/pkg-pr-new is not installed on vitest-dev/vitest."}

We didn't install anything

sheremet-va · 2024-09-26T10:12:17Z

Should be installed now

userquin · 2024-09-26T10:12:49Z

you need to add the app to vitest repo: https://github.com/stackblitz-labs/pkg.pr.new?tab=readme-ov-file#setup

pkg-pr-new · 2024-09-26T10:15:47Z

@vitest/coverage-istanbul

pnpm add https://pkg.pr.new/@vitest/coverage-istanbul@6362

@vitest/browser

pnpm add https://pkg.pr.new/@vitest/browser@6362

@vitest/coverage-v8

pnpm add https://pkg.pr.new/@vitest/coverage-v8@6362

@vitest/expect

pnpm add https://pkg.pr.new/@vitest/expect@6362

@vitest/pretty-format

pnpm add https://pkg.pr.new/@vitest/pretty-format@6362

@vitest/mocker

pnpm add https://pkg.pr.new/@vitest/mocker@6362

@vitest/spy

pnpm add https://pkg.pr.new/@vitest/spy@6362

@vitest/snapshot

pnpm add https://pkg.pr.new/@vitest/snapshot@6362

@vitest/runner

pnpm add https://pkg.pr.new/@vitest/runner@6362

@vitest/utils

pnpm add https://pkg.pr.new/@vitest/utils@6362

@vitest/ui

pnpm add https://pkg.pr.new/@vitest/ui@6362

vite-node

pnpm add https://pkg.pr.new/vite-node@6362

@vitest/web-worker

pnpm add https://pkg.pr.new/@vitest/web-worker@6362

@vitest/ws-client

pnpm add https://pkg.pr.new/@vitest/ws-client@6362

vitest

pnpm add https://pkg.pr.new/vitest@6362

commit: 094916a

userquin · 2024-09-26T10:27:11Z

@userquin We discussed about how to trigger pkg.pr.new and we agreed "cr-tracked" label based workflow is okay. I'll push a few commits here and see how it goes.

Check vitepress repo, using vue bot, check cr.yml and cr-comment.yml here: https://github.com/vuejs/vitepress/tree/main/.github/workflows

hi-ogawa · 2024-09-26T10:33:24Z

@userquin cr-comment.yml doesn't look necessary since we can just add label manually when we want to allow PRs to be released. Isn't it only doing /publish comment to trigger adding label cr-tracked indirectly?

userquin · 2024-09-26T10:47:01Z

@hi-ogawa I've sent you an invitation to vue discord server and a link to Vitepress room/channel, I asked brc_dd and his answer was:

Actually, github actions can also add labels but labels added via their default bot cannot trigger other actions. 🫠 That's why add it using separate user.

sheremet-va · 2024-09-26T11:03:50Z

Actually, github actions can also add labels but labels added via their default bot cannot trigger other actions. 🫠 That's why add it using separate user.

We don't want to add labels automatically. The idea is that the maintainer adds a label to allow CR manually

hi-ogawa · 2024-09-26T11:07:16Z

Yeah, I just also checked re-labeling "cr-tracked" and this alone can also trigger CR correctly. https://github.com/vitest-dev/vitest/actions/workflows/cr.yml

hi-ogawa · 2024-09-26T23:12:53Z

I tested a few examples locally and also on stackblitz and it looks working https://stackblitz.com/edit/vitest-dev-vitest-ei9jaw?file=package.json
I think we can proceed with this PR.

… into userquin/chore-add-pkg-pr-new

patak-dev · 2024-09-27T07:45:23Z

For reference, adding the label automatically refers to this scheme:

chore: pkg.pr.new preview with label and comment vitejs/vite#18211

I think adding a label instead of a comment is quite nice too, so good to move forward with this PR as is. I think in Vite we'll keep the comment (with the label workaround). We can try both approaches and see what ends up working best.

sheremet-va

Do we need a mention in the readme/documentation that we have this? We have this for example: https://vitest.dev/guide/#using-unreleased-commits

userquin · 2024-09-30T16:12:11Z

Do we need a mention in the readme/documentation that we have this? We have this for example: https://vitest.dev/guide/#using-unreleased-commits

https://github.com/vite-pwa/vite-plugin-pwa/blob/main/.github/pull_request_template.md

sheremet-va · 2024-09-30T16:20:41Z

Do we need a mention in the readme/documentation that we have this? We have this for example: vitest.dev/guide#using-unreleased-commits

vite-pwa/vite-plugin-pwa@main/.github/pull_request_template.md

The comment can only be added by the maintainers

We also publish every commit on main

… into userquin/chore-add-pkg-pr-new

hi-ogawa · 2024-10-01T00:10:43Z

I just pushed a few commits but pkg-pr-new publish is getting stuck today.
@Aslemammad Could it be some infra issue? Would be great to know if there's something we can do to diagnose issue.

EDIT: Oh, it got OOM https://github.com/vitest-dev/vitest/actions/runs/11115894967/job/30885165567#step:7:22

Aslemammad · 2024-10-01T04:44:43Z

interesting, can you trigger a re-run for the failed workflow?

hi-ogawa · 2024-10-01T04:54:53Z

Thanks for the help. I started a re-run and it looks like it's still stuck.

Aslemammad · 2024-10-01T05:20:56Z

That's bad, I'll just have a look soon!

Aslemammad · 2024-10-01T09:34:42Z

I think it is fixed now, feel free to trigger a re-run!

hi-ogawa · 2024-10-01T09:57:05Z

@Aslemammad Thanks! I confirmed pkg-pr-new is working now https://github.com/vitest-dev/vitest/actions/runs/11115894967/job/30904769639?pr=6362

Aslemammad · 2024-10-01T10:18:44Z

Happy to hear that ❤️

chore: add pkg-pr-new

22d2d04

userquin changed the title ~~chore: add pkg-pr-new~~ chore: add pkg.pr.new Aug 19, 2024

Aslemammad reviewed Aug 19, 2024

View reviewed changes

AriPerkkio reviewed Aug 20, 2024

View reviewed changes

.github/PULL_REQUEST_TEMPLATE.md Outdated Show resolved Hide resolved

sheremet-va reviewed Aug 20, 2024

View reviewed changes

.github/workflows/cr.yml Show resolved Hide resolved

hi-ogawa added the p2-to-be-discussed Enhancement under consideration (priority) label Sep 26, 2024

sheremet-va removed the p2-to-be-discussed Enhancement under consideration (priority) label Sep 26, 2024

hi-ogawa added 3 commits September 26, 2024 18:37

Merge branch 'main' into userquin/chore-add-pkg-pr-new

ba34e1a

ci: run cr on main

514f1c6

chore: remove cr-comment.ymml

beb4a57

hi-ogawa added the cr-tracked label Sep 26, 2024

ci: fix action

ea2af4d

Merge branch 'main' into userquin/chore-add-pkg-pr-new

e985120

hi-ogawa removed the cr-tracked label Sep 26, 2024

hi-ogawa added the cr-tracked label Sep 26, 2024

hi-ogawa requested a review from sheremet-va September 26, 2024 23:12

hi-ogawa added 2 commits September 27, 2024 11:02

chore: remove non-draft check

4a45789

Merge remote-tracking branch 'upstream/userquin/chore-add-pkg-pr-new'…

fda24f3

… into userquin/chore-add-pkg-pr-new

hi-ogawa mentioned this pull request Sep 27, 2024

chore: pkg.pr.new preview with label and comment vitejs/vite#18211

Open

sheremet-va reviewed Sep 30, 2024

View reviewed changes

hi-ogawa added 4 commits October 1, 2024 08:25

Merge branch 'main' into userquin/chore-add-pkg-pr-new

61450cd

docs: update

b6467eb

Merge remote-tracking branch 'upstream/userquin/chore-add-pkg-pr-new'…

8ffa4b4

… into userquin/chore-add-pkg-pr-new

ci: tweak

094916a

sheremet-va merged commit 9edfa19 into main Oct 1, 2024
9 checks passed

sheremet-va deleted the userquin/chore-add-pkg-pr-new branch October 1, 2024 19:37

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: add `pkg.pr.new` #6362

chore: add `pkg.pr.new` #6362

userquin commented Aug 19, 2024 •

edited by hi-ogawa

Loading

netlify bot commented Aug 19, 2024 •

edited

Loading

Aslemammad Aug 19, 2024

userquin Aug 19, 2024 •

edited

Loading

Aslemammad Aug 19, 2024

Aslemammad commented Aug 19, 2024

hi-ogawa commented Sep 26, 2024

hi-ogawa commented Sep 26, 2024

sheremet-va commented Sep 26, 2024

sheremet-va commented Sep 26, 2024

userquin commented Sep 26, 2024

pkg-pr-new bot commented Sep 26, 2024 •

edited

Loading

userquin commented Sep 26, 2024

hi-ogawa commented Sep 26, 2024

userquin commented Sep 26, 2024 •

edited

Loading

sheremet-va commented Sep 26, 2024

hi-ogawa commented Sep 26, 2024

hi-ogawa commented Sep 26, 2024

patak-dev commented Sep 27, 2024

sheremet-va left a comment

userquin commented Sep 30, 2024

sheremet-va commented Sep 30, 2024 •

edited

Loading

hi-ogawa commented Oct 1, 2024 •

edited

Loading

Aslemammad commented Oct 1, 2024

hi-ogawa commented Oct 1, 2024

Aslemammad commented Oct 1, 2024

Aslemammad commented Oct 1, 2024 •

edited

Loading

hi-ogawa commented Oct 1, 2024

Aslemammad commented Oct 1, 2024

chore: add pkg.pr.new #6362

chore: add pkg.pr.new #6362

Conversation

userquin commented Aug 19, 2024 • edited by hi-ogawa Loading

Description

Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

Tests

Documentation

Changesets

netlify bot commented Aug 19, 2024 • edited Loading

✅ Deploy Preview for vitest-dev ready!

Aslemammad Aug 19, 2024

Choose a reason for hiding this comment

userquin Aug 19, 2024 • edited Loading

Choose a reason for hiding this comment

Aslemammad Aug 19, 2024

Choose a reason for hiding this comment

Aslemammad commented Aug 19, 2024

hi-ogawa commented Sep 26, 2024

hi-ogawa commented Sep 26, 2024

sheremet-va commented Sep 26, 2024

sheremet-va commented Sep 26, 2024

userquin commented Sep 26, 2024

pkg-pr-new bot commented Sep 26, 2024 • edited Loading

userquin commented Sep 26, 2024

hi-ogawa commented Sep 26, 2024

userquin commented Sep 26, 2024 • edited Loading

sheremet-va commented Sep 26, 2024

hi-ogawa commented Sep 26, 2024

hi-ogawa commented Sep 26, 2024

patak-dev commented Sep 27, 2024

sheremet-va left a comment

Choose a reason for hiding this comment

userquin commented Sep 30, 2024

sheremet-va commented Sep 30, 2024 • edited Loading

hi-ogawa commented Oct 1, 2024 • edited Loading

Aslemammad commented Oct 1, 2024

hi-ogawa commented Oct 1, 2024

Aslemammad commented Oct 1, 2024

Aslemammad commented Oct 1, 2024 • edited Loading

hi-ogawa commented Oct 1, 2024

Aslemammad commented Oct 1, 2024

chore: add `pkg.pr.new` #6362

chore: add `pkg.pr.new` #6362

userquin commented Aug 19, 2024 •

edited by hi-ogawa

Loading

netlify bot commented Aug 19, 2024 •

edited

Loading

userquin Aug 19, 2024 •

edited

Loading

pkg-pr-new bot commented Sep 26, 2024 •

edited

Loading

userquin commented Sep 26, 2024 •

edited

Loading

sheremet-va commented Sep 30, 2024 •

edited

Loading

hi-ogawa commented Oct 1, 2024 •

edited

Loading

Aslemammad commented Oct 1, 2024 •

edited

Loading