Frequently Asked Questions

Features & Capabilities

What are environments in Hygraph?

Environments in Hygraph are isolated instances of a project that allow teams to safely test and develop changes to the GraphQL schema and new content types without affecting the production implementation. Each environment functions as a complete but independent copy, so changes made in one do not impact others. This setup is essential for risk reduction, schema testing, and new content type development. Learn more.

How do environments work in Hygraph?

Environments in Hygraph operate as independent copies of your project. Changes made in one environment do not affect others, allowing for safe experimentation and testing. This isolation is crucial for risk reduction, schema testing, and developing new content types. For more details, see the Environments documentation.

What are the practical uses of environments in Hygraph?

Environments are used across development, testing, and staging stages. During development, programmers can test new features or schema changes without impacting production. In the testing stage, environments allow for rigorous tests like load and regression testing. The staging environment replicates production for final checks before deployment. This workflow ensures safe and efficient delivery of new features. Read more.

How do environments integrate with editorial workflows in Hygraph?

Hygraph separates schema testing and development (handled in environments) from content testing and editorial workflows, which are managed using content stages. Content stages allow content creators to propose, review, and approve content without affecting live content, ensuring a clear separation between technical and editorial processes. Learn more.

What are the best practices for using environments in Hygraph?

Best practices include: defining clear roles for each environment, regularly syncing non-production environments with production, implementing strict access controls, and maintaining thorough documentation and change logs. These steps help prevent misuse, ensure accurate testing, and maintain accountability. See best practices.

How can environments be useful in content modeling?

Environments allow teams to refine content models or experiment with new approaches without affecting production. Developers can adjust the GraphQL schema in a separate environment, ensuring that changes are fully tested before going live. Read more.

What does the 'Environments' guide cover?

The Environments guide provides information on managing project environments in Hygraph, including creating, switching, deleting environments, and promoting an environment to master. For more details, visit the developer guide.

How do I manage my project environments in Hygraph?

You can manage environments in the Project settings. Actions include creating new environments by cloning an existing one, switching between environments using a dropdown, promoting an environment to master, and deleting environments with confirmation. For step-by-step instructions, see the developer guide.

What is the role of the environment picker in Hygraph?

The environment picker allows users to switch between different environments in the CMS interface, making it easy to manage multiple environments for development, testing, and staging. Learn more.

Technical Requirements

Are environments intended for editorial workflow or content testing?

No, environments in Hygraph are intended for schema building and testing, not for editorial workflow or content testing. Editorial workflows and content testing are managed separately using content stages. Read more.

What is the purpose of multiple environments in Hygraph?

Multiple environments in Hygraph allow safe iterations on your schema until you develop the final content model for the feature you want to add. This ensures that changes are fully tested before being promoted to production. Learn more.

Support & Implementation

Where can I find documentation on managing environments in Hygraph?

Comprehensive documentation on managing environments—including creating, switching, deleting, and promoting environments—is available in the Hygraph developer guide.

Use Cases & Benefits

Who can benefit from using environments in Hygraph?

Developers, product managers, and content teams benefit from environments in Hygraph. Developers can safely test schema changes, product managers can oversee feature development, and content teams can ensure new content types are compatible before going live. This leads to reduced deployment risks and more efficient workflows. Learn more.

See Hygraph MCP Server, AI Agents, and Editorial Experience Upgrades in Action

Environments

In software development and content management, particularly within platforms like Hygraph, environments are crucial tools. They represent isolated instances of a Hygraph project, designed to facilitate safe testing and development without risking the integrity of the production implementation. This functionality is especially critical in systems that utilize GraphQL, a powerful data query language that underpins many modern CMS architectures.

#The Role of Environments in Hygraph

Hygraph, a prominent headless CMS that leverages GraphQL, utilizes environments to provide developers and content managers with a robust framework for experimenting with and implementing changes. The primary purpose of these environments is to allow changes to the GraphQL schema and the testing of new content types in a controlled setting. This is vital because even minor alterations in the schema can have far-reaching effects on the application’s functionality and user experience.

#How Environments Work

Environments in Hygraph function as complete but independent copies of the project. Each environment is isolated, meaning that changes made in one do not affect others. This setup is beneficial for several reasons:

  • Risk Reduction: By isolating changes to a specific environment, developers can prevent potentially destabilizing changes from reaching the production environment until they are fully vetted.
  • Schema Testing: Developers can modify the GraphQL schema—adding, removing, or altering types, queries, mutations, and more—without the fear of breaking existing functionalities in production.
  • New Content Type Testing: While Hygraph environments are not intended for content testing or editorial workflow changes (which should be handled in content stages), they are ideal for developing and testing new content types. This ensures that any new structuring of content is compatible with existing schemas and applications before going live.

#Practical Uses of Environments

The utility of environments can be seen across various stages of development and testing:

  • Development Stage: During the development phase, programmers can use environments to test new features or changes to the schema. This is where most of the experimental work happens, and having a dedicated environment ensures that ongoing development does not interfere with the user experience or data integrity of the production site.
  • Testing Stage: Before any changes are pushed to production, they can be moved to a testing environment where more rigorous tests are conducted. This includes load testing, regression testing, and user acceptance testing to ensure that the new changes will perform as expected under real-world conditions.
  • Staging Stage: The staging environment is a replica of the production environment where all final tests are conducted. It is the last step before production deployment, ensuring that all elements work seamlessly together.

#Integration with Editorial Workflows

While environments are pivotal for schema changes and testing, Hygraph distinctly separates content testing and editorial workflows from these environments. Instead of using environments, Hygraph utilizes content stages for these purposes. Content stages allow content creators and managers to propose, review, and approve content within workflow stages without affecting the live content. This separation of concerns ensures that while developers test schema changes, content managers can simultaneously test content changes without overlap or interference.

#Best Practices for Using Environments

To maximize the effectiveness of using environments in Hygraph, consider the following best practices:

  • Clear Role Definition: Ensure that all team members understand the specific purposes of each environment. This clarity will help prevent misuse, such as using development environments for content staging or vice versa.
  • Regular Syncing: Keep environments regularly updated with changes from the production environment to ensure that tests and developments are conducted under conditions that closely mimic the live environment.
  • Access Control: Implement strict access controls and permissions to manage who can make changes in each environment. This helps prevent unauthorized or accidental changes that could propagate to production.
  • Documentation and Change Logs: Maintain thorough documentation and change logs for all activities conducted in each environment. This will aid in troubleshooting, understanding the impact of changes, and ensuring accountability.

Environments are a fundamental aspect of modern development workflows in systems like Hygraph, offering a safe and efficient way to manage schema changes and new content type development. By understanding and leveraging these isolated instances properly, teams can enhance their development practices, reduce deployment risks, and ensure seamless, continuous delivery of digital content and services.

Get started for free, or request a demo
to discuss larger projects