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

Getting started #1104

Merged
merged 17 commits into from
May 24, 2022
Merged

Getting started #1104

merged 17 commits into from
May 24, 2022

Conversation

BrynCooke
Copy link
Contributor

@BrynCooke BrynCooke commented May 19, 2022

To test follow these instructions: https://deploy-preview-1104--apollo-router-docs.netlify.app/customizations/custom-binary

But when creating the project you'll need to specify the branch when calling cargo-scaffold.

cargo-scaffold scaffold https://github.com/apollographql/router.git -r apollo-router-scaffold/templates/base -t origin/bryn/getting-started --param branch=bryn/getting-started

@netlify
Copy link

netlify bot commented May 19, 2022

Deploy Preview for apollo-router-docs canceled.

Name Link
🔨 Latest commit d287e7b
🔍 Latest deploy log https://app.netlify.com/sites/apollo-router-docs/deploys/628cc99e80303c0009db0db9

@github-actions

This comment has been minimized.

@BrynCooke BrynCooke force-pushed the bryn/getting-started branch from a30f4a3 to c865033 Compare May 21, 2022 09:02
@BrynCooke BrynCooke marked this pull request as ready for review May 22, 2022 07:18
@BrynCooke BrynCooke requested a review from StephenBarlow as a code owner May 22, 2022 07:18
@BrynCooke BrynCooke force-pushed the bryn/getting-started branch from 296615f to 7a214fb Compare May 23, 2022 09:04
Copy link
Contributor

@o0Ignition0o o0Ignition0o left a comment

Choose a reason for hiding this comment

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

This looks amazing 🎉 Just one question (I m not sure if it s a leftover or intentional; otherwise lgtm!)

@BrynCooke BrynCooke force-pushed the bryn/getting-started branch from 867efb1 to 0cc7e37 Compare May 24, 2022 09:07
@BrynCooke BrynCooke requested a review from bnjjj May 24, 2022 09:29
@BrynCooke BrynCooke force-pushed the bryn/getting-started branch from 8902adf to e7e291c Compare May 24, 2022 09:56
@BrynCooke BrynCooke requested a review from prasek May 24, 2022 10:09
@BrynCooke BrynCooke self-assigned this May 24, 2022
bryn and others added 17 commits May 24, 2022 14:02
Users can in a single command scaffold a project.
Once they have a project they can scaffold three different types of plugin.
Signed-off-by: Benjamin Coenen <5719034+bnjjj@users.noreply.github.com>
Moka has a dependency on Quanta which had an issue with AMD hardware. This is now fixed via [Moka-#119](moka-rs/moka#119).
@BrynCooke BrynCooke force-pushed the bryn/getting-started branch from 54172b8 to d287e7b Compare May 24, 2022 12:03
@BrynCooke BrynCooke merged commit 2ad7420 into main May 24, 2022
@BrynCooke BrynCooke deleted the bryn/getting-started branch May 24, 2022 12:23
@BrynCooke BrynCooke linked an issue May 24, 2022 that may be closed by this pull request
@o0Ignition0o
Copy link
Contributor

just tried to run this and had this:

ignition@ignition-apollo starstuff % cargo b
    Updating crates.io index
    Updating git repository `https://github.com/apollographql/router.git`
    Updating git submodule `https://github.com/apollographql/supergraph-demo-fed2.git`
    Updating git submodule `https://github.com/apollographql/federation-demo.git`
error: no matching package named `apollo-router-scaffold` found
location searched: https://github.com/apollographql/router.git?tag=v0.9.2
required by package `xtask v0.1.0 (/Users/ignition/projects/oss/starstuff/xtask)`

@BrynCooke BrynCooke restored the bryn/getting-started branch May 24, 2022 12:31
@BrynCooke
Copy link
Contributor Author

Just in case others are trying to test, you MUST run the following to scaffold and not the one in the docs:

cargo-scaffold scaffold https://github.com/apollographql/router.git -r apollo-router-scaffold/templates/base -t origin/bryn/getting-started --param branch=bryn/getting-started

This patches up the generated files to work against this branch.

@hboylan
Copy link

hboylan commented May 26, 2022

@BrynCooke This getting-started branch works, but it does not match the current documentation. Is there already an issue/PR to resolve the template from the main branch?

@BrynCooke
Copy link
Contributor Author

@hboylan I think that once a release happens then everything will start working. The problem is that apollo-router-scaffold does not exist in v0.9.2. Once v0.9.3 is released it'll be OK.

We need to fix things so that docs are pinned to the latest release rather than main, otherwise we will constantly get issues like this.

@abernix abernix added this to the v0.9.3 milestone May 31, 2022
@garypen garypen mentioned this pull request May 31, 2022
@abernix abernix deleted the bryn/getting-started branch May 16, 2024 10:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Doc: Using the router as a library
5 participants