Skip to content

Releases: hashicorp-forge/hermes

v0.4.0

19 Jan 23:13
@anubhavmishra anubhavmishra
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.
Compare
Choose a tag to compare
v0.4.0 Latest
Latest

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

Read more

Contributors

jeffdaley, jfreda, and 2 other contributors
Assets 2

v0.3.0

17 Aug 22:44
@anubhavmishra anubhavmishra
v0.3.0
ab87e2b
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
v0.3.0

Breaking changes

  • New required google_workspace.domain config attribute. (@jfreda in #261) 
    google_workspace {
  // domain is the Google Workspace domain (e.g., "hashicorp.com").
  domain = "your-domain-dot-com"
}

Notable features & enhancements

  • (NEW) Related resources for documents: Ability to add and view related resources such as RFCs, PRDs, and other related content links to things like mockups, video recordings, etc. Hermes users can use the document sidebar to add related resources to their documents.
    (NEW) Easy sharing for document drafts: Ability to easily share Hermes document drafts with the organization members before requesting review or publishing the document for company wide comments.
  • Improved request review modal: Design tweaks to make the process of requesting review clearer.
  • Interactive product badges: Product or area badges are now clickable and will initiate a product filter to show a list of documents associated with a product or area.
  • Improved “document awaiting review” design: Documents that are awaiting review are shown with a new design in the Hermes dashboard
  • Support documents link: The footer and user navigation now includes an optional support link that can be supplied via the server config by setting support_link_url

What's Changed

Full Changelog: v0.2.0...v0.3.0

Contributors

jeffdaley, jfreda, and anubhavmishra
Assets 2

v0.2.0

16 Jun 17:31
@anubhavmishra anubhavmishra
v0.2.0
b34f51e
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
v0.2.0

Notable features & enhancements

  • Reauthenticating in one tab will automatically reauthenticate in other Hermes tabs too.
  • Documents that contain suggestions in the header are automatically locked due to a Google Docs bug where suggestions cannot be deleted by the Google Docs API.
  • There’s now an X button to remove people in the multi-select dropdowns (e.g., approvers, contributors).
  • Document owners can now change the product for a document draft.
  • Search now supports (ArrowUp/ArrowDown) keyboard navigation.
  • Product suggestions in the search popover (e.g., “View all [productName] docs”) are more accurate, and go away when there is no match.
  • Products are now searchable within the dropdowns (if the list is long enough).

Notable bug fixes

  • Recently viewed documents are sorted correctly again.
  • Document owners can now see approver checkmarks in the sidebar.
  • API error messages are now displayed correctly in flash messages in the frontend.
  • An error message now shows when a document fails to save.
  • Duplicate error messages are prevented from showing.

What's Changed

New Contributors

Full Changelog: v0.1.0...v0.2.0

Contributors

jrschumacher, jeffdaley, and 2 other contributors
Assets 2

v0.1.0

05 May 22:46
@anubhavmishra anubhavmishra
v0.1.0
200759d
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
v0.1.0

Breaking changes

  • If Okta is configured for auth, a new aws_region parameter in the okta configuration block is required. (@jfreda in #144)
    The Admin SDK API now needs to be enabled. (@jfreda in #144)
  • Google Analytics can be enabled by setting the google_analytics_tag_id parameter in the application config file or using the GOOGLE_ANALYTICS_TAG_ID environment variable. (@jeffdaley in #104)
  • Environment variables (HERMES_WEB_GOOGLE_OAUTH2_CLIENT_ID) are not required at build time to configure Google auth anymore. These values are instead sourced from the application config at runtime. (@jfreda in #170)

Notable features & enhancements

  • When Okta is configured for auth, users do not have to login to Google anymore.
  • Drafts are now included in Recently Viewed Documents on the dashboard.
  • When a session expires, the user is not redirected immediately to the authenticate screen anymore (this could be very disruptive when authoring a document). Instead a flash message now appears, letting the user know that their session has expired and prompting them to reauthenticate.
  • Document drafts can now be viewed and edited by contributors.
  • A number of design system components have been upgraded.
  • A 404 route has been added.

Notable bug fixes

  • The original request URL is preserved through authenticating (via Okta or Google).
  • Approvers can now be added or removed for document drafts.

What's Changed

Read more

Contributors

jrschumacher, jeffdaley, and 2 other contributors
Assets 2

v0.0.1

09 Feb 23:51
@anubhavmishra anubhavmishra
v0.0.1
e88b1c1
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
v0.0.1

What's Changed

New Contributors

Full Changelog: https://github.com/hashicorp-forge/hermes/commits/v0.0.1

Contributors

meirish, jrschumacher, and 4 other contributors
Assets 2