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

Add instructions for how to install & configure HIE for use with Hasura Haskell development #3819

Closed
wants to merge 3 commits into from

Conversation

GavinRay97
Copy link
Member

@GavinRay97 GavinRay97 commented Feb 1, 2020

Description

Adds a section in the CONTRIBUTING.md guide on how to install and configure Haskell IDE Engine for use with Hasura.

Affected components

  • Server
  • Console
  • CLI
  • Docs
  • Community Content
  • Build System
  • Tests
  • Other (list it)

Related Issues

Solution and Design

Steps to test and verify

Limitations, known bugs & workarounds

Server checklist

Catalog upgrade

Does this PR change Hasura Catalog version?

  • No
  • Yes
    • Updated docs with SQL for downgrading the catalog

Metadata

Does this PR add a new Metadata feature?

  • No
  • Yes
    • Does run_sql auto manages the new metadata through schema diffing?
      • Yes
      • Not required
    • Does run_sql auto manages the definitions of metadata on renaming?
      • Yes
      • Not required
    • Does export_metadata/replace_metadata supports the new metadata added?
      • Yes
      • Not required

GraphQL

  • No new GraphQL schema is generated
  • New GraphQL schema is being generated:
    • New types and typenames are correlated

Breaking changes

  • No Breaking changes

  • There are breaking changes:

    1. Metadata API

      Existing query types:

      • Modify args payload which is not backward compatible
      • Behavioural change of the API
      • Change in response JSON schema
      • Change in error code
    2. GraphQL API

      Schema Generation:

      • Change in any NamedType
      • Change in table field names

      Schema Resolve:-

      • Change in treatment of null value for any input fields
    3. Logging

      • Log JSON schema has changed
      • Log type names have changed

@hasura-bot
Copy link
Contributor

Beep boop! 🤖

Hey @GavinRay97, thanks for your PR!

One of my human friends will review this PR and get back to you as soon as possible.

Stay awesome! 😎

@lexi-lambda lexi-lambda added the c/server Related to server label Feb 4, 2020
@davetapley
Copy link

This helped me hugely 💯

@netlify
Copy link

netlify bot commented Apr 14, 2020

Deploy preview for hasura-docs ready!

Built with commit ebf1c13

https://deploy-preview-3819--hasura-docs.netlify.com

Comment on lines +20 to +23
### Haskell + HIE Devcontainer

VS Code provides the ability to develop applications inside of a Docker container (called _Devcontainers_)
https://code.visualstudio.com/docs/remote/containers
Copy link
Contributor

Choose a reason for hiding this comment

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

I am reluctant to add information to the CONTRIBUTING.md that involves a workflow that nobody on the server team actually uses and therefore cannot meaningfully support. However, I believe @0x777 does have a workflow that he uses involving HIE; maybe he can speak to that here?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c/community Related to community content c/server Related to server community-contrib 🙏🏽
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants