c3 add final commit to pages projects #3769

dario-piotrowicz · 2023-08-15T17:16:04Z

TODO:

add --commit-message to wrangler pages deploy in case we aren't in a repository
add git = <git version> in the commit message
add wrangler = wrangler@<wrangler version> in the commit message
add e2e tests for the commit message

TODO after merging this PR:

create issue to track the monorepo edge case
(mentioning that the potential solution is to check before committing if there are unstaged changes outside
the current directory and in that case notify the user ask the user and ask them if they are ok with C3 generating
the commit)

Fixes # [insert GH or internal issue number(s)].

What this PR solves / how to test:

Associated docs issue(s)/PR(s):

[insert associated docs issue(s)/PR(s)]

Author has included the following, where applicable:

Tests
Changeset (Changeset guidelines)

Reviewer is to perform the following, as applicable:

Checked for inclusion of relevant tests
Checked for inclusion of a relevant changeset
Checked for creation of associated docs updates
Manually pulled down the changes and spot-tested

Note for PR author:

We want to celebrate and highlight awesome PR review! If you think this PR received a particularly high-caliber review, please assign it the label highlight pr review so future reviewers can take inspiration and learn from it.

packages/create-cloudflare/src/pages.ts

github-actions · 2023-08-15T17:21:39Z

A wrangler prerelease is available for testing. You can install this latest build in your project with:

npm install --save-dev https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/5892511639/npm-package-wrangler-3769

You can reference the automatically updated head of this PR with:

npm install --save-dev https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/prs/5892511639/npm-package-wrangler-3769

Or you can use npx with this latest build directly:

npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/5892511639/npm-package-wrangler-3769 dev path/to/script.js

Additional artifacts:

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/5892511639/npm-package-cloudflare-pages-shared-3769

Note that these links will no longer work once the GitHub Actions artifact expires.

changeset-bot · 2023-08-15T17:26:18Z

🦋 Changeset detected

Latest commit: 70c9312

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
create-cloudflare	Minor

Not sure what this means? Click here to learn what changesets are.

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

codecov · 2023-08-15T17:29:50Z

Codecov Report

Merging #3769 (f86af28) into main (478bed3) will not change coverage.
Report is 1 commits behind head on main.
The diff coverage is n/a.

❗ Current head f86af28 differs from pull request most recent head 70c9312. Consider uploading reports for the commit 70c9312 to get more accurate results

@@           Coverage Diff           @@
##             main    #3769   +/-   ##
=======================================
  Coverage   75.17%   75.17%           
=======================================
  Files         194      194           
  Lines       11410    11410           
  Branches     3013     3013           
=======================================
  Hits         8577     8577           
  Misses       2833     2833

dario-piotrowicz · 2023-08-15T20:09:24Z

Converted to draft as I need to tweak the details in the commit message and figure out how we want to handle monorepos

jculvey

It would be nice to have some test coverage for this if it's easy.

The one hurdle thats been on the backlog is fixing git commits in e2e which fails silently atm since there isn't a git user and email configured inside of the newly created project folder. It would be nice if we could somehow add this config in tests mode and then verify the commit was made via git at the end of a test run.

jculvey · 2023-08-15T20:27:00Z

packages/create-cloudflare/src/pages.ts

@@ -61,7 +66,7 @@ export const runPagesGenerator = async (args: C3Args) => {
 	}
 	await updatePackageScripts(ctx);
 	await offerGit(ctx);
-	await gitCommit(ctx);
+	await gitCommit(ctx, generatePagesCommitMessage(ctx));


For consistency and to accommodate some changes I'd like to make later, it would be better if we kept the signature as is, and did some branching logic inside gitCommit function itself to generate the commit one way or the other depending on if it's pages or workers.

You can check this condition by evaluating the truthiness of ctx.framework -- it will be defined for pages apps but not for workers. Ideally, we'd have a dedicated field that gets set early on in the process (i.e. ctx.projectType = 'workers') which we could key off of, but we can use ctx.framework as a close enough proxy for now.

ah ok thanks, I'll move the change in the function sorry about that 🙂:+1:

Updated: 68474ca

Please have a look and let me know if this looks ok to you 🙂

packages/create-cloudflare/src/pages.ts

dario-piotrowicz · 2023-08-15T20:42:02Z

@jculvey yes, I was wondering of the testing situation... I wasn't sure if the tests are ready for covering this, it sounds like they're not completely there, I don't mind having a look and if it doesn't make this PR go hugely out of scope I don't mind adding them here 🙂👍

IgorMinar

this is looking good, leaving a few comments...

packages/create-cloudflare/src/common.ts

packages/create-cloudflare/src/frameworks/cliMap.json

packages/create-cloudflare/src/common.ts

packages/create-cloudflare/src/frameworks/package.json

IgorMinar

once more nit, but the rest looks great. please adjust and go ahead and merge

packages/create-cloudflare/src/frameworks/package.json

dario-piotrowicz · 2023-08-16T16:04:23Z

please adjust and go ahead and merge

sorry I've still got a few items todo (I've noted them in the PRs description) 🙇

Also... the C3 tests cleanup workflow is failing... it's probably not ok to merge with it is failing 😓 (seems like its missing the CLOUDFLARE_API_TOKEN) I might need to look at this separately 🤔

packages/create-cloudflare/src/common.ts

dario-piotrowicz · 2023-08-17T12:50:27Z

I don't think that the e2e tests can run on this PR since I created it from a forked repo, you can see the tests running in this other temporary PR I created just in order to test those: #3776

To keep things simple maybe is easier to just close this PR in favour of #3776 ?

dario-piotrowicz · 2023-08-18T15:32:06Z

Closing this in favour of #3776 (which is practically the same PR but created from an internal branch)

Sorry for the inconvenience 🙇

dario-piotrowicz requested review from a team as code owners August 15, 2023 17:16

dario-piotrowicz commented Aug 15, 2023

View reviewed changes

packages/create-cloudflare/src/pages.ts Outdated Show resolved Hide resolved

c3 add final commit to pages projects

bc35cd8

dario-piotrowicz force-pushed the c3-commit-changes branch from ae17f02 to bc35cd8 Compare August 15, 2023 20:04

dario-piotrowicz marked this pull request as draft August 15, 2023 20:08

jculvey reviewed Aug 15, 2023

View reviewed changes

dario-piotrowicz added 7 commits August 15, 2023 23:02

move framework commit message generation inside gitCommit

68474ca

add framework cli name and version to framework commit

ed295c8

add package manager info to framework commit

28d1ffa

run prettify

69d37c4

make commit header imperative

32ec02e

update Web to web

6549396

lowercase Create-Cloudflare

80eb55e

IgorMinar reviewed Aug 16, 2023

View reviewed changes

dario-piotrowicz added 2 commits August 16, 2023 16:20

refactor generateFrameworkCommitMessage to generateCommit message

34b7577

convert cliMap.json to package.json so that we can leverage dependabot

cb95d52

dario-piotrowicz commented Aug 16, 2023

View reviewed changes

packages/create-cloudflare/src/frameworks/package.json Outdated Show resolved Hide resolved

IgorMinar self-requested a review August 16, 2023 15:54

IgorMinar approved these changes Aug 16, 2023

View reviewed changes

packages/create-cloudflare/src/frameworks/package.json Outdated Show resolved Hide resolved

add wrangler version to commit message

18d6ebf

add git version to commit

71880c5

dario-piotrowicz added 2 commits August 16, 2023 17:42

run prettify

d05ae87

move comments to description field

a6183b3

dario-piotrowicz commented Aug 16, 2023

View reviewed changes

packages/create-cloudflare/src/common.ts Outdated Show resolved Hide resolved

improve git version gathering

e9c832c

dario-piotrowicz force-pushed the c3-commit-changes branch from df02cbd to 3c4dd78 Compare August 16, 2023 23:59

dario-piotrowicz added 9 commits August 17, 2023 13:59

run C3 e2e tests only on internal PRs (cloudflare#3777)

83d37ca

add commit message to deployment without git

37a1476

fix the commit message addition to wrangler pages deploy

ca29ece

fix user facing label

18afa4f

fix commit message not being properly passed

6ac1c49

run prettify

4638697

add e2e for deployment commit message

abbcd24

run prettify

bbb89e6

fix incorrectly gathering projectName

70c9312

dario-piotrowicz force-pushed the c3-commit-changes branch from e858eb2 to 70c9312 Compare August 17, 2023 14:53

dario-piotrowicz closed this Aug 18, 2023

dario-piotrowicz mentioned this pull request Aug 18, 2023

[C3] add final commit to pages projects #3776

Merged

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

c3 add final commit to pages projects #3769

c3 add final commit to pages projects #3769

dario-piotrowicz commented Aug 15, 2023 •

edited

Loading

github-actions bot commented Aug 15, 2023 •

edited

Loading

changeset-bot bot commented Aug 15, 2023 •

edited

Loading

codecov bot commented Aug 15, 2023 •

edited

Loading

dario-piotrowicz commented Aug 15, 2023

jculvey left a comment

jculvey Aug 15, 2023

dario-piotrowicz Aug 15, 2023

dario-piotrowicz Aug 15, 2023

dario-piotrowicz commented Aug 15, 2023

IgorMinar left a comment

IgorMinar left a comment

dario-piotrowicz commented Aug 16, 2023 •

edited

Loading

dario-piotrowicz commented Aug 17, 2023 •

edited

Loading

dario-piotrowicz commented Aug 18, 2023

c3 add final commit to pages projects #3769

c3 add final commit to pages projects #3769

Conversation

dario-piotrowicz commented Aug 15, 2023 • edited Loading

github-actions bot commented Aug 15, 2023 • edited Loading

changeset-bot bot commented Aug 15, 2023 • edited Loading

🦋 Changeset detected

codecov bot commented Aug 15, 2023 • edited Loading

Codecov Report

dario-piotrowicz commented Aug 15, 2023

jculvey left a comment

Choose a reason for hiding this comment

jculvey Aug 15, 2023

Choose a reason for hiding this comment

dario-piotrowicz Aug 15, 2023

Choose a reason for hiding this comment

dario-piotrowicz Aug 15, 2023

Choose a reason for hiding this comment

dario-piotrowicz commented Aug 15, 2023

IgorMinar left a comment

Choose a reason for hiding this comment

IgorMinar left a comment

Choose a reason for hiding this comment

dario-piotrowicz commented Aug 16, 2023 • edited Loading

dario-piotrowicz commented Aug 17, 2023 • edited Loading

dario-piotrowicz commented Aug 18, 2023

dario-piotrowicz commented Aug 15, 2023 •

edited

Loading

github-actions bot commented Aug 15, 2023 •

edited

Loading

changeset-bot bot commented Aug 15, 2023 •

edited

Loading

codecov bot commented Aug 15, 2023 •

edited

Loading

dario-piotrowicz commented Aug 16, 2023 •

edited

Loading

dario-piotrowicz commented Aug 17, 2023 •

edited

Loading