Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update C3 OpenAPI template to allow users to pick either Hono or itty-router #6106

Merged
merged 1 commit into from
Jul 5, 2024

Conversation

G4brym
Copy link
Member

@G4brym G4brym commented Jun 20, 2024

What this PR solves / how to test

This pr updates the C3 OpenAPI template to allow users to pick either Hono or itty-router.

Example usage:
npm create cloudflare@latest -- --type openapi --framework hono
npm create cloudflare@latest -- --type openapi --framework itty-router

Author has addressed the following

  • Tests
    • TODO (before merge)
    • Included
    • Not necessary because:
  • E2E Tests CI Job required? (Use "e2e" label or ask maintainer to run separately)
    • I don't know
    • Required / Maybe required
    • Not required because:
  • Changeset (Changeset guidelines)
    • TODO (before merge)
    • Included
    • Not necessary because:
  • Public documentation
    • TODO (before merge)
    • Cloudflare docs PR(s):
    • Not necessary because:

@G4brym G4brym requested review from a team as code owners June 20, 2024 13:51
Copy link

changeset-bot bot commented Jun 20, 2024

🦋 Changeset detected

Latest commit: c7f9794

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

This PR includes changesets to release 2 packages
Name Type
create-cloudflare Minor
@cloudflare/prerelease-registry Patch

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

@G4brym G4brym force-pushed the update-c3-openapi-template branch from 4fe29dc to 34d5888 Compare June 20, 2024 13:53
Copy link
Contributor

github-actions bot commented Jun 20, 2024

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/9804221077/npm-package-wrangler-6106

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

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

Or you can use npx with this latest build directly:

npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/9804221077/npm-package-wrangler-6106 dev path/to/script.js
Additional artifacts:
npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/9804221077/npm-package-create-cloudflare-6106 --no-auto-update
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/9804221077/npm-package-cloudflare-kv-asset-handler-6106
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/9804221077/npm-package-miniflare-6106
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/9804221077/npm-package-cloudflare-pages-shared-6106
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/9804221077/npm-package-cloudflare-vitest-pool-workers-6106

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


[email protected] includes the following runtime dependencies:

Package Constraint Resolved
miniflare workspace:* 3.20240701.0
workerd 1.20240701.0 1.20240701.0
workerd --version 1.20240701.0 2024-07-01

Please ensure constraints are pinned, and miniflare/workerd minor versions match.

@G4brym G4brym force-pushed the update-c3-openapi-template branch 4 times, most recently from e86eed6 to 601ec03 Compare June 21, 2024 08:24
@petebacondarwin petebacondarwin self-assigned this Jun 21, 2024
@petebacondarwin petebacondarwin removed their assignment Jun 21, 2024
@G4brym
Copy link
Member Author

G4brym commented Jun 21, 2024

Builds are failing because the PR is done from a forked repo, but should otherwise be green

@G4brym G4brym force-pushed the update-c3-openapi-template branch from d2f3439 to c533a49 Compare June 22, 2024 09:49
@G4brym G4brym changed the title Update c3 openapi template to use chanfana and Hono Update C3 OpenAPI template to allow users to pick either Hono or itty-router Jun 22, 2024
@G4brym
Copy link
Member Author

G4brym commented Jun 22, 2024

I've updated the pull request, to allow users to pick either Hono or itty-router as the base framework for this c3 template.
Pull request is ready to be merged

@G4brym G4brym force-pushed the update-c3-openapi-template branch 8 times, most recently from 3d1937d to 957df44 Compare June 22, 2024 13:52
},
"dependencies": {
"@cloudflare/itty-router-openapi": "^1.0.1"

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this really needed?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, this old dependency needs to be removed

@G4brym G4brym force-pushed the update-c3-openapi-template branch 3 times, most recently from 47de9f1 to a4764fb Compare June 27, 2024 16:07
@G4brym
Copy link
Member Author

G4brym commented Jul 4, 2024

Hey @jculvey , the C3 E2E builds are failing for reasons not related to this pr, do you think you could merge this?

@petebacondarwin petebacondarwin self-assigned this Jul 5, 2024
Copy link
Contributor

@petebacondarwin petebacondarwin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I pushed this branch to our fork to run the e2e tests. See #6207.
They are now green.

.changeset/metal-seahorses-occur.md Outdated Show resolved Hide resolved
@petebacondarwin petebacondarwin merged commit 286cdd6 into cloudflare:main Jul 5, 2024
40 of 45 checks passed
@workers-devprod workers-devprod mentioned this pull request Jul 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

None yet

5 participants