Skip to content

v0.4.0

Latest
Latest
Compare
Choose a tag to compare
@anubhavmishra anubhavmishra released this 19 Jan 23:13
· 114 commits to main since this release
v0.4.0
dd50ccd
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Learn about vigilant mode.

Breaking changes

  • New required config attribute projects_index_name. This is required even if Hermes projects are not enabled yet via the feature flag. (#447) 
    algolia {
  ...
  projects_index_name       = "projects"
  ...
}

Enabling Hermes projects

Hermes projects (see below under "Notable features & enhancements") can be enabled via feature flag:

feature_flags {
  flag "projects" {
    enabled = true
  }
}

Enabling v2 of the API

This release includes a new v2 of the Hermes API which uses the PostgreSQL database as the source of truth for all data instead of Algolia. v1 of the API is now considered deprecated and will be removed in the next release. First, to prepare for enabling v2 of the API, use the new hermes operator migrate-algolia-to-postgresql command (use the -help flag to see all available options) to migrate all data to PostgreSQL. Then, v2 of the API can be enabled via feature flag:

feature_flags {
  flag "api_v2" {
    enabled = true
  }
}

Other notable configuration changes

  • New flight_icon attribute under document types (using Helios icons):
document_types {
  document_type "RFC" {
    ...
    flight_icon = "discussion-circle"
    ...
  }
}
  • Jira can be optionally configured to enable linking Hermes projects with Jira issues. Create an API token for Jira and then enable Jira linking with the jira block in the config:
jira {
  api_token = ""
  enabled   = true
  url       = ""
  user      = ""
}
  • Hermes logs can now be emitted in JSON:
log_format = "json"
  • Datadog tracing can be optionally enabled:
datadog {
  enabled = true
  env     = "prod"
  service = "hermes"
}

Notable features & enhancements

  • (NEW) Custom document types: Users can now define their own document types in the Hermes configuration file.
  • (NEW) Introducing Projects in Hermes: Projects provide a way to group documents (including documents from multiple products) and links around an effort. Hermes users can create a project in Hermes and link published documents to that project. Users can optionally also link the associated Jira issue to provide a richer understanding about the status of the project.
  • Datadog tracing is now supported (new datadog config block).
  • "My Docs" and "My Drafts" routes are now combined.
  • Improved keyboard support for editable fields.
  • Numerous performance and design improvements for the Hermes UI.
  • The document type is now included in the Google Doc header title (e.g., "[RFC] ABC-123: Title of my doc").

What's Changed

New Contributors

Full Changelog: v0.3.0...v0.4.0

Contributors

jeffdaley, jfreda, and 2 other contributors
Assets 2