Skip to content
This repository was archived by the owner on Apr 14, 2023. It is now read-only.

Document how to configure schemaTag in operation registry plugin - AP-468#466

Merged
cheapsteak merged 5 commits intomasterfrom
chang/op-safelist-docs
Jun 7, 2019
Merged

Document how to configure schemaTag in operation registry plugin - AP-468#466
cheapsteak merged 5 commits intomasterfrom
chang/op-safelist-docs

Conversation

@cheapsteak
Copy link
Copy Markdown
Contributor

@cheapsteak cheapsteak commented May 31, 2019

(Note: can merge after apollographql/apollo-tooling#1307 is released. update: released)

This PR adds 2 optional sub-steps in the setup flow to demonstrate how to configure the schema tag for the operation registry plugin and the cli

It also removes the "Only the default schema tag (current) is supported." section from the "Limitations" section

@cheapsteak cheapsteak requested review from daniman and evans May 31, 2019 21:33
@cheapsteak cheapsteak requested a review from zionts as a code owner May 31, 2019 21:33
@cheapsteak cheapsteak changed the title Document how to configure schemaTag in operation registry plugin Document how to configure schemaTag in operation registry plugin - AP-468 May 31, 2019
Copy link
Copy Markdown
Contributor

@daniman daniman left a comment

Choose a reason for hiding this comment

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

Nice, thanks @cheapsteak! 😸

})
]
});
```
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We should also mention the need to set the tag in the client push command here in order to get the operations into the manifest the plugin pulls

@cheapsteak cheapsteak requested a review from evans June 5, 2019 14:15
Copy link
Copy Markdown
Contributor

@evans evans left a comment

Choose a reason for hiding this comment

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

Let's make sure we release the plugin and new apollo version before publishing these new docs


####5.1 Optionally, set the schema tag

The plugin will automatically pickup the value of the environment variable `ENGINE_SCHEMA_TAG` and use that as the schema tag.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

If users specify this env var, then our new changes will be breaking, since they'll pick up a new manifest. Let's make sure this is in the upgrade guide

Copy link
Copy Markdown
Contributor Author

@cheapsteak cheapsteak Jun 6, 2019

Choose a reason for hiding this comment

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

I will remove this to match changes in https://github.com/apollographql/apollo-platform-commercial/pull/125

Thanks for picking up on this 🙏

The only way to specify a tag will initially be manually passing it in through the config to avoid a breaking change
@cheapsteak cheapsteak changed the title Document how to configure schemaTag in operation registry plugin - AP-468 [no merge yet] Document how to configure schemaTag in operation registry plugin - AP-468 Jun 6, 2019
@cheapsteak cheapsteak changed the title [no merge yet] Document how to configure schemaTag in operation registry plugin - AP-468 Document how to configure schemaTag in operation registry plugin - AP-468 Jun 7, 2019
@cheapsteak cheapsteak merged commit 220ce7c into master Jun 7, 2019
@cheapsteak cheapsteak deleted the chang/op-safelist-docs branch June 7, 2019 18:47
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants