3.0.0-RC2

These Release Notes are for ZenHub Enterprise (On-Premise), for customers using ZenHub for Kubernetes with GitHub Enterprise Server.

• For all users using ZenHub Enterprise (On-Premise) for VMs, version ZenHub Enterprise 3.1 will provide support for VM based upgrades. Please wait until that version is available. For information about your current 2.x application, please the the v2.x releases.
• For all users using ZenHub on GitHub.com, please check out our new feature announcements on our product changelog.

IMPORTANT: ZenHub Enterprise 3.0.0-RC2 supports the following GitHub Enterprise versions: [2.21] (https://enterprise.github.com/releases/series/2.21), 2.22, and 3.0.

What's new in ZenHub Enterprise 3.0.0-RC2

Release Date: March 19, 2021

Bug Fixes

• Chrome and Firefox browser extension installation workflows are now fully supported
• Admin UI for extension publishing, first ZenHub Admin creation, and Usage Report is now fully supported
• Added a new manifest_firefox_id configuration option to fix Firefox extension publishing
• Fixed file_url MongoDB database migration configuration to support AWS DocumentDB
• Fixed mongorestore command in the migration instructions for users upgrading from ZHE 2.x
• Fixed a bug which prevented users from creating more than 1 project in the ZenHub Roadmaps feature
• Fixed a bug which caused certain options to be missing from the ZenHub Roadmaps feature
• Fixed a bug which prevented real-time board updates from working properly (related to GitHub webhooks)
• Fixed a bug which caused the "Manage organizations" link to go to a broken page
• Fixed a bug which displayed an invalid link when inviting users to your Board
• Fixed a broken link to the extension configuration documentation in the Admin UI

3.0.0-RC1

These Release Notes are for ZenHub Enterprise (On-Premise), for customers using ZenHub for Kubernetes with GitHub Enterprise Server.

• For all users using ZenHub Enterprise (On-Premise) for VMs, version ZenHub Enterprise 3.1 will provide support for VM based upgrades. Please wait until that version is available. For information about your current 2.x application, please the the v2.x releases.
• For all users using ZenHub on GitHub.com, please check out our new feature announcements on our product changelog.

IMPORTANT: ZenHub Enterprise 3.0.0-RC1 supports the following GitHub Enterprise versions: 2.21, 2.22, and 3.0.

What's new in ZenHub Enterprise 3.0.0-RC1

Release Date: March 5, 2021

With this release, ZenHub Enterprise 3.0.0 is leaving the beta phase and entering Release Candidate. We don't expect any more major development or configuration changes to the application, and will be using this version to conduct some final tests with our beta customers before making it available for general access.

Admin UI

A new administrative app which is accessible via a dedicated URL. The app allows operators to:

• Assign ZenHub administrator users
• Manage the publishing and distribution of ZenHub browser extensions
• Review and access system usage reports

Migration scripts

Scripts to migrate data from ZenHub Enterprise (On-Premise) v2 to v3

Documentation

Updated documentation for deployment

Configuration

• Simplified some configuration items
• improved deployment for configuration options
• Updated application images to the latest 2.44 builds

3.0.0-beta.3

These Release Notes are for ZenHub Enterprise (On-Premise), for customers using ZenHub for Kubernetes with GitHub Enterprise Server.

• For all users using ZenHub Enterprise (On-Premise) for VMs, version ZenHub Enterprise 3.1 will provide support for VM based upgrades. Please wait until that version is available. For information about your current 2.x application, please the the v2.x releases.
• For all users using ZenHub on GitHub.com, please check out our new feature announcements on our product changelog.

IMPORTANT: ZenHub Enterprise 3.0.0-beta.3 supports the following GitHub Enterprise versions: 2.21, and 2.22.

What's new in ZenHub Enterprise 3.0.0-beta.3

Release Date: January 21, 2021

Auto-generated internal SSL certificate

• Internal SSL certificates used by nginx-gateway are now automatically generated

Terraform Module

• A Terraform module for AWS is available to deploy all backend resources required to run ZenHub

New Application Images

• Updated application images to the latest 2.44 builds

3.0.0-beta.2.0

These Release Notes are for ZenHub Enterprise (On-Premise), for customers using ZenHub for Kubernetes with GitHub Enterprise Server.

• For all users using ZenHub Enterprise (On-Premise) for VMs, version ZenHub Enterprise 3.1 will provide support for VM based upgrades. Please wait until that version is available. For information about your current 2.x application, please the the v2.x releases.
• For all users using ZenHub on GitHub.com, please check out our new feature announcements on our product changelog.

What's new in ZenHub Enterprise 3.0.0-beta.2.0

Release Date: January 15, 2021

IMPORTANT: ZenHub Enterprise 3.0.0-beta.2.0 supports the following GitHub Enterprise versions: 2.21, and 2.22.

New Repository Structure

• Manifests are now organized per application, with all files and guides for ZenHub for Kubernetes located inside the k8s-cluster folder
• When ZenHub Enterprise (On-Premise) for VMs is ready, all the files and guides will be located inside a folder called virtual-machine

ZHE2 to ZHE3 Data Migration Guide

• Within the k8s-cluster folder is also the new zhe3-migration folder, which contains scripts and instructions for migrating data from ZHE2 to ZHE3

User managed variables

• The main kustomization.yaml is now the only place required to input all of your user-defined variables and secrets

New deployment procedure

• Manifests are deployed utilizing the latest version of kustomize at the time of this release (3.9.x)

kustomize build . | kubectl diff -f-

TLS

• SSL/TLS connection between ingress and ZHE (nginx-gateway)

Kubernetes Manifests

This repository now includes Kubernetes manifests and kustomize configuration files compatible with application images v2.44. For customers that are looking to configure ZenHub on an existing Kubernetes cluster, please follow the instructions in our README.

3.0.0-beta.1

These Release Notes are for ZenHub Enterprise (On-Premise), for customers using ZenHub Kubernetes with GitHub Enterprise.

• For all users using ZenHub Enterprise (On-Premise) for VMs, version ZenHub Enterprise 3.1 will provide support for VM based upgrades. Please wait until that version is available. For information about your current 2.x application, please the the v2.x releases.
• For all users using ZenHub on GitHub.com, please check out our new feature announcements on our product changelog.

What's new in ZenHub Enterprise 3.0-beta.1

Release Date: November 20, 2020

IMPORTANT: ZenHub Enterprise 3.0-beta supports the following GitHub Enterprise versions: 2.21, and 2.22.

Kubernetes Manifests

This repository now includes Kubernetes manifests and kustomize configuration files compatible with application images v2.44. For customers that are looking to configure ZenHub on an existing Kubernetes cluster, please follow the instructions in our README.

v2.44

These Release Notes are for ZenHub Enterprise (On-Premise), for customers using ZenHub with GitHub Enterprise. For all users using ZenHub on GitHub.com, please check out our new feature announcements on our product changelog.

What's new in ZenHub Enterprise 2.44

Release Date: July 20, 2020

IMPORTANT: ZenHub Enterprise 2.44 supports the following GitHub Enterprise versions: 2.20, 2.21, 2.22, and 3.0.

*With additional patches for compatibility (see below).

Patches

DOMPurify Vulnerability

The Firefox Add-ons team has flagged a library used by the ZenHub Enterprise extension called DOMPurify with a cross-site scripting vulnerability. As such, our team has created a patch for ZenHub Enterprise 2.44 to address this vulnerability by upgrading the DOMPurify library to a more up-to-date version. The patch will update the library and rebuild the extension bundles. You will need to update your extensions (both Chrome and Firefox) after applying the patch. In order to apply the patch, please SSH to your ZenHub Enterprise appliance and execute the following command:

curl -O https://zenhub.s3.amazonaws.com/enterprise/enterprise-patches/2.44/zhe244-dompurify-patch.tar.gz && tar -xzf zhe244-dompurify-patch.tar.gz && sudo ./dompurify-fix/install-and-build-ext.sh

GHE 2.22 Compatibility

GitHub recently released their minor version for GitHub Enterprise, 2.22. This version contains changes that broke compatibility with the current ZenHub Enterprise 2.44 extensions for Chrome and Firefox. As such, we have created a patch to restore compatibility. You will need to update your extensions (both Chrome and Firefox) after applying the patch. This patch also re-enables the Epic Builder, a feature that was accidentally disabled upon the release of ZenHub Enterprise 2.44. The patch will cause about 30 seconds of downtime as the backend services are restarted. In order to apply the patch, please SSH to your ZenHub Enterprise appliance and execute the following command:

curl -O https://zenhub.s3.amazonaws.com/enterprise/enterprise-patches/2.44/ghe222-patch.tar.gz && tar -xzf ghe222-patch.tar.gz && sudo ./ghe222-patch/install-and-build-ext.sh

GHE 3.0 Compatibility

On Feb. 16, 2021, GitHub released GitHub Enterprise 3.00. This included changes to the authentication API that requires a ZenHub patch to maintain compatibility. This patch will not require you to republish your extensions after updating. The patch will cause about 30 seconds of downtime as the backend services are restarted. In order to apply the patch, please SSH to your ZenHub Enterprise appliance and execute the following command:

curl -O https://zenhub.s3.amazonaws.com/enterprise/enterprise-patches/2.44/ghe300-patch.tar.gz && tar -xzf ghe300-patch.tar.gz && sudo ./ghe300-patch/install-and-build-ext.sh

License governance: control user access to ZenHub

ZenHub Enterprise 2.44 introduces complete control over licensing on your team. ZenHub Admins can now view total and remaining licenses, license requests from team members, and assign licenses individually or in bulk. On top of that, we've updated the UI around upcoming renewal dates so there are never any surprises.

ZenHub Admins will have access to three options for their teams to join ZenHub:

1. Always (Unlimited)
   Automatically grant unlimited new licenses and remove any interruption from getting started with ZenHub.
2. Up to license limits
   Automatically grant licenses up to your account limit. Once you've hit your limit, you can still assign licenses on a per-user basis.
3. Never auto-assign
   All users will need a ZenHub Admin to grant new licenses.

Visit our Help guides for more information.

Roadmap improvements

Red-Yellow-Green status, predicted end dates for Epics, and options for viewing progress

We've introduced an option to enable color-coded projects, determined by their progress. A red, yellow, or green color instantly indicates status, communicating whether a project is on track (green), at-risk (yellow), or falling behind (red).

We've also added the option for teams to enable “predicted end dates” for Epics in their Roadmaps. Predicted end dates provide a visual indication when a project is running behind schedule and can help teams proactively have conversations around reducing scope. Read more about these exciting changes!

Lastly, you can now customize your Roadmap view so progress is shown by the number (#) of Issues completed, number (#) of Story points completed, percentage (%) of Issues completed, or percentage (%) of story points completed. Click on the gear icon to toggle between options which are then saved for when you return to the Roadmap or navigate to a different Roadmap in your organization.

Bug fixes and changes

• Bug Fix A race condition when creating Issues with a Release and an Estimate would show a broken statistics between total and estimated scope was found and fixed.
• Bug Fix Fixed issue on web app limiting file size to 1MB with drag-and-drop to upload as well as clicking the "Attach files..." button. Both of these now allow up to 15MB. GitHub limitations will still be set to 5MB and copy-paste-to-upload may be limited depending on the file type and browser policies.
• Bug Fix The Velocity report will now show open Milestones past their due dates for up to 30 days. Previously, they were removed from the report once their due date had passed.
• Bug Fix When tabbing through the Issue sidebar, collapsed Workspace pipelines will now be skipped over.
• Bug Fix Overflow the tabs on the navbar (rather than break into two lines) when there isn't enough space.
• Bug Fix When creating a new Issue in GitHub, the Epics dropdown will now show "No Epics yet" instead of an infinite "Loading..." text.
• Bug Fix When hovering on filtered dropdowns, the hover state will work as intended rather than skipping some items.

Updates for ZenHub Admins

• Known bug: ZenHub extensions will not be able to be downloaded in the event of an outage

ZenHub's open product roadmap

We would like to say “thank you” to users who left feedback on our open roadmap! We read, categorize, and use every comment to support future improvements and inform our decisions throughout the discovery and design phases of all new developments.

A special “thank you” goes out to everyone who left feedback and joined us for visual testing of Roadmaps while it was in the early stages of development. We hope you can see how your direct feedback influenced the final product!

That's all for now ✌🏻!

v2.43

These Release Notes are for ZenHub Enterprise (On-Premise), for customers using ZenHub with GitHub Enterprise. For all users using ZenHub on GitHub.com, please check out our new feature announcements on our product changelog.

NOTE FOR ADMINS

Your appliance must be on Ubuntu 16.04 (Xenial) before upgrading. If you are currently running an older version, please review the Ubuntu 14.04 → 16.04 upgrade guide prior to running the upgrade.

What's new in ZenHub Enterprise 2.43

Release Date: June 8, 2020

ZenHub Enterprise 2.43 resolves two issues and includes security updates from 2.42.

• Bug fix Resolves an issue with the ZenHub ↔ GitHub connection for customers using a privately-signed SSL/TLS certificate on their GitHub Enterprise Server.
• Bug fix Resolves an issue where a ZenHub process was trying to use an outdated version of Node.js.
• Security Additional rate-limiting has been added to the ZenHub Administrator login page to mitigate against brute-force attacks.
• Security We have deprecated support for TLS 1 and TLS 1.1 connections for ZenHub Enterprise in favor of supporting TLS 1.2 only.
• Security We have modernized our list of approved SSL/TLS cipher suites to further improve the security of our TLS connections.

What this means for you:

• If you are currently on ZenHub Enterprise 2.42 and are experiencing these issues, upgrading to 2.43 will resolve them.
• If you are currently on ZenHub Enterprise 2.42 and are not experiencing these issues, you may upgrade to receive the security updates.
• If you are currently on version ZenHub Enterprise 2.39 or earlier, you can upgrade directly to 2.43 with no impact.

Although there are no product changes in between 2.42 and 2.43, we’ve included the updates from 2.42 below for your reference. For any questions, please reach us at support@zenhub.com.

v2.42

These Release Notes are for ZenHub Enterprise (On-Premise), for customers using ZenHub with GitHub Enterprise. For all users using ZenHub on GitHub.com, please check out our new feature announcements on our product changelog.

NOTE FOR ADMINS:

Your appliance must be on Ubuntu 16.04 (Xenial) before upgrading. If you are currently running an older version, please reach out to us at enterprise@zenhub.com prior to running the upgrade.

What's new in ZenHub Enterprise 2.42

Release Date: May 4, 2020

IMPORTANT: ZenHub Enterprise 2.42 supports the following GitHub Enterprise versions: 2.18, 2.19 and 2.20.

Plan, align, and envision with ZenHub Roadmaps

Communicate your Projects in advance, stay up to date with accurate progress

ZenHub Roadmaps allow you to organize your Projects and Epics into a gantt-style timeline view in order to plan your team's long-term product roadmap. Communicate product and business strategy across your organization, continuously powered by your development team.

Benefits of ZenHub Roadmaps for your team:

• Real-time progress tracking of your Projects
  Easily view the status of your Projects at a glance. Identify potential delays to key initiatives and implement strategies to get back on track. Progress is tracked based on completed work meaning updates are built on automated, accurate data.
• Eliminate status update meetings
  Development teams can stay focused on their area of expertise: writing, maintaining, and innovating with code. Using GitHub Issues as a foundation, the Roadmap will contextualize their work, communicating progress and eliminating the need for avoidable meetings.
• Complete transparency across the team
  Communicate business strategy to key team members and provide them with valuable insights into future product direction. Provide stakeholders with a clear view into the development lifecycle without interruption to the team.

Learn more about ZenHub Roadmaps.

Cache, database improvements to core ZenHub APIs

We’ve been slowly rolling out our own ZenHub API service (codename “Raptor”) that allows us to move a lot of that heavy lifting to our own servers and make use of a centralized database cache. As of this release, it is now in production across all of our Cloud and Enterprise platforms! ZenHub Roadmaps is largely powered by our Raptor backend as well as a few other upgrades across the app.

The Velocity report was the first piece we were able to upgrade to our new infrastructure. The changes substantially improve load times for teams with a large number of Milestones. On our own report, we saw an 85% improvement in speed! If you've had a slow report in the past, check out your Velocity report to experience how the upgrades will affect our future changes to the Board.

Stay tuned and read about our decisions, changes, and the future technical challenges of ZenHub from our Head of Engineering, Ev Haus.

New Markdown editor to simplify text styling

Quick and easy formatting at the click of a button

Have you ever forgotten which awkward character you need to type to make text bold or italic or create a link? Fear no more! We've introduced a small toolbar on top of all post and comment sections in the web app to assist you in your user story and bug reporting endeavours.

Learn more about styling with Markdown.

Export any Report to better understand the details

Analyze your data, personalize your experience, customize your insights

Are you part of a data-driven team that needs to dive deeper into your metrics? Or maybe you need to tweak certain parts of reports — or even certain reports altogether. An export option is now available for all five ZenHub Reports meaning you can freely analyze data to suit your team's goals.

Navigate to any one of your reports where you will see the export option located in the top right of the chart, next to the report title.

What does this mean for your team?

• Provide executives and key stakeholders with detailed information and key insights into the team's workflow.
• Customize your data! By exporting your Reports to CSVs you can create custom graphs and charts to present to your team.

Bug fixes, performance updates, and UI changes

• Performance improvement By consolidating network requests across repositories, and optimizing some of our internal database queries, we’ve been able to make substantial improvements to the initial load time of your Board. For most of our users, this effort translates to Boards loading 20% faster!
• Performance improvement We’ve improved the loading speed for the “New Issue” dialog. It should now load much faster as it no longer relies on having to download GitHub’s Issue templates with every request. By implementing local caching of this data, we’ve been able to get the dialog to launch nearly instantly - a ~65% reduction!
• Performance improvement For our web app users, loading details of existing Issues is 30% faster today than it was yesterday! We’ve moved to progressively load an Issue into three parts: the initial post, the Issue timeline, and the sidebar actions.
• Performance improvement We’ve identified and fixed a Board load performance issue affecting users who have a large number of Releases. This was caused by some inefficient code in our application which would block the main thread from being able to continue rendering the application. Users with many Releases should see noticeable Board speed improvements.
• Performance improvement We’ve heard feedback that performing bulk editing operations on large numbers of issues can be a less than ideal experience. The app would sometimes appear frozen and the updates would not be clearly reflected on the issue cards. For this reason, we’ve improved the performance and experience of performing bulk edit operations on GitHub data - such as labels, milestones, and assignees - on the Board using card multi-select. Moreover, users will now be shown a progress bar indicating the status of this operation.
• Performance improvement We have also looked into caching strategies for all of our bulk editing action lists such as Labels, Assignees, Releases, and Milestones. The dropdown lists for those items will load instantly if users have already interacted with those items earlier in their browsing session. This will allow you to be more effective when making changes by going through your tickets issue-by-issue, for example, during sprint planning or refinement sessions.
• Performance improvement We’ve reduced the time it takes to fetch labels in multi-repository Workspaces, specifically when loading the label dropdown menus or the label selector on the issue page. We’ve done this by leveraging some new caching techniques of our new backend. We are hoping to continue to roll out more optimizations of this nature in the coming months.
• UI Improvement Filter by real names — everywhere! Some common tasks such as managing ticket assignment, planning, and filtering, can become daunting and time-consuming when we don’t know everyone’s GitHub usernames which can vary wildly from our colleague’s real names. To help teams save time, users can now filter by real names using the assignee filter.
• UI Improvement For web app users, Issues closed by a commit now have a link to the specific commit.
• UI Improvement See the full title for long organization and repo names. Finding the organization or repo you want can be hard due to long titles and limited space. To save time and reduce this frustration, we have split the two names into different lines and, if that's not enough, you can hover over the items to reveal the extended title.
• UI Improvement For large teams, it can be difficult to find repos to add to a Workspace because of rate limit issues with GitHub. We've added a link on the "Add Repos" list when the list is empty.
• Bug Fix For extension users, we fixed a bug that was breaking @mentions and #issue references in Pull Request dialogs from the Board.
• Bug Fix After hearing feedback around losing context when clicking links, external links will now open in a new tab to allow you to return to your position and focus.
• Bug Fix We've reduced occurrences of a redirection loop that used to be triggered when navigating between Github’s Issue/Pull Request search page and the ZenHub board.
• Bug Fix For extension users, the timeline of events in an Issue was out of order. This has since been fixed and events are back to their chronological order.
• Bug Fix When switching between Workspaces, you will stay in context on the current screen rather than redirected back to the Board.
• Bug Fix After users have been removed from the organization, opening some Issues on the web app would freeze because we were missing profile information. For events triggered by now-removed users, Issues will show "Someone" triggered the event.
• Bug Fix A race condition was found and fixed when an Issue was...