Releases: ZenHubHQ/zenhub-enterprise
Zenhub Enterprise 3.4.1
These release notes are for Zenhub Enterprise for Virtual Machine and Zenhub Enterprise for Kubernetes.
- For all users using Zenhub on github.com, please check out our new feature announcements on our product changelog.
- For administrators planning upgrades, please refer to the section "Important Upgrade Instructions for Administrators".
IMPORTANT: Zenhub Enterprise 3.4.1 supports GitHub Enterprise versions: 3.4, 3.5, 3.6
What's new in Zenhub Enterprise 3.4.1
Features
- No new features in this patch release
Security Fixes
- Package security updates
- OS security updates
- Updated supported cipher suites
Bug Fixes
- Fixed a bug causing database migration jobs to fail if a deleted repository had contained an Epic that was present on a Roadmap.
Changes
- Added back support for a layer 4/7 load balancer performing TLS termination in front of the application that was inadvertently removed in v3.4.0
Known Issues
Too many authentication failuresmay be reported when attempting to SSH into the VM, which can be caused by multiple SSH keys loaded in the connecting workstation's SSH agent. A workaround is present in the documentation.
VM Embedded Component Versions
| Component | Version |
|---|---|
| Ubuntu | 20.04.4 |
| K3s | v1.21.11+k3s1 |
| Kubernetes | v1.21.11 |
| Kustomize | v3.9.4 |
| Fluentd | v1.6-debian-1 |
| Postgresql | 11.16 |
| MongoDB | 4.4.13 |
| RabbitMQ | 3.8.31 |
| Redis | 6.2.7 |
| PgBouncer | 1.15.0 |
Important Upgrade Instructions for Administrators
Zenhub Enterprise for Virtual Machine
⚠️ NOTE: For the upgrade from ZHE 3.3 -> ZHE 3.4, the regular rollback steps cannot be used. Please perform a machine level snapshot prior to upgrading to use as a backup in case you need to revert back to ZHE 3.3 for any reason.
-
You must be running ZHE 3.3.X or 3.4.1 to perform the upgrade to ZHE 3.4.1.
-
For users currently running Zenhub Enterprise, look for an email from our team which will include a download link for the 3.4.1 upgrade package. The upgrade process is detailed in our documentation.
Zenhub Enterprise for Kubernetes
- Some extra upgrade instructions have been added specifically for this release due to some database changes that accompany the application updates. Please follow the upgrade instructions below for this release:
1. Prepare
- Get the
kustomization.yamlyou configured to setup Zenhub - Perform a diff to make sure no outstanding changes are waiting to be applied
kustomize build . | kubectl diff -f-It should exit 0 and only display a warning of unused variables. If changes are pending, apply them before starting the upgrade process.
- Make a copy of your existing
kustomization.yamland keep it handy for the next step
2. Update kustomization.yaml
- Check out the
zenhub-enterpriserepository at the tag of this release - Populate the new
kustomization.yamlwith your existing configuration values
Be sure to replace any additional customized configuration (such as ingress, TLS configuration) with your original configuration from before as well.
- A new ingress definition has been added to this release in
options/ingress/ingress-cable.yaml. You will need to set the TLS secret name and annotations to suite your ingress, similar to your other configured Zenhub ingress objects. - If you are using your own registry and not Zenhub's registry, upload the new images tagged with this release to your registry.
3. Database changes
⚠️ NOTE: Running this script is only required if you are upgrading from ZHE 3.3.
- Run the script found in
k8s-cluster/update/zhe-upgrade.shvia the commands below:
If you use the ZenHub registry
cd update
./zhe-upgrade.sh yourNamespaceIf you use your own registry
cd update
./zhe-upgrade.sh yourNamespace yourRegistryName4. Application updates
In your new kustomization.yaml, update the cluster image tags to use the new images for this release:
If you are using your own registry, ensure that the newName fields are configured for that instead of Zenhub's
images:
- name: kraken-webapp
newName: us.gcr.io/zenhub-public/kraken-webapp
newTag: zhe-3.4.1
- name: kraken-extension
newName: us.gcr.io/zenhub-public/kraken-extension
newTag: zhe-3.4.1
- name: kraken-zhe-admin
newName: us.gcr.io/zenhub-public/kraken-zhe-admin
newTag: zhe-3.4.1
- name: raptor-backend
newName: us.gcr.io/zenhub-public/raptor-backend
newTag: zhe-3.4.1
- name: toad-backend
newName: us.gcr.io/zenhub-public/toad-backend
newTag: zhe-3.4.1
- name: sanitycheck
newName: us.gcr.io/zenhub-public/sanitycheck
newTag: zhe-3.4.1
- name: busybox
newName: docker.io/library/busybox
newTag: latest
- name: nginx
newName: docker.io/library/nginx
newTag: latest- Then perform a diff to check what the upgrade will do (this command must be run from the directory that contains your
kustomization.yaml
kustomize build . | kubectl diff -f-- If everything looks correct, you can deploy the cluster via:
kustomize build . | kubectl apply -f-5. Finalize
- Securely store the updated
kustomization.yaml
Zenhub Enterprise 3.4.0
These release notes are for Zenhub Enterprise for Virtual Machine and Zenhub Enterprise for Kubernetes.
- For all users using Zenhub on github.com, please check out our new feature announcements on our product changelog.
- For administrators planning upgrades, please refer to the section "Important Upgrade Instructions for Administrators".
IMPORTANT: Zenhub Enterprise 3.4.0 supports GitHub Enterprise versions: 3.4, 3.5
What's new in Zenhub Enterprise 3.4.0
Features
Epic flyover on the roadmap
You will no longer be tabbed out into a new page once you click on your epic on the roadmap. Instead we've enabled the flyover similar to what we do for issues on the board so you never have to leave your roadmap when reading or updating your epics.
When creating epics, auto add to roadmap with the ability to opt out
Adding epics to a roadmap can be time consuming so we do it for you if you want us to. Whenever you create an epic we'll add it to your workspace roadmap by checking a box at the bottom of the epic create page. You can opt out if you don't want to add your epic by unchecking this box. If you quick create an epic we'll automatically add it to the roadmap for you. You can always remove your epics from your roadmap if you don't want them there as you normally could.
Productivity Insights out of beta
Spend less time pouring over reports and see exactly what you need, directly on the board. These insights will:
Automatically break down work in progress into development & review time so you can understand how long each phase is taking.
Let you know when review time is taking significantly longer than development time so you’re aware of blockers, sooner.
Additionally, we’ve added anomalies tracking to show you which issues took abnormally long to complete. This will help you identify why cycle time might be rising, spot trends among particularly challenging issues, and prompt conversation among the team.
Roadmap drag and drop
You can now manually reorder items on the Roadmap using drag and drop! Sort your Roadmap by start date, end date, or manually by using the drop-down menu in the top right corner.
Board 2.0
Our Board 2.0 has been built for speed and efficiency from the ground up. We’ve observed the following improvements:
In addition to our speed improvements, we’ve also taken the opportunity to add a few new features to the board and make incremental improvements to existing ones. We’ve made the following feature changes to the board:
Easily groom your board with an improved drag and drop experience
We’ve rebuilt our drag and drop experience for the board to make moving and re-ordering issues on the board buttery smooth. We’ve also added new subtle animations and made tweaks behind the scenes to improve reliability when dragging issues across the board.
Identify bottlenecks with separated pipeline counts
Our pipeline counts provide a quick summary of issues and PR’s in a pipeline. To help our users better understand this count, we’ve broken out the count into separate categories for Issues, Pull Requests, and Points. This change trades the obscurity of the previous count for the accuracy and detail of seeing card-specific counts at a glance.
Easily scan your board with less clutter thanks to a cleaner board view
Over time, we’ve heard feedback from users that the board can appear cluttered once each issue has several labels, sprints, and releases that are tied to each card. To help create a cleaner board view, we’ve elongated each issue card and removed some of the auxiliary information from each card in the board view.
Minimize interruptions with increased reliability
As part of our board rebuild, we’ve taken the time to address several bugs and reliability issues that were occasionally present in the old board. By addressing these issues we have created a more reliable board experience that results in less error for users when taking board actions, including creating issues.
Multi-select can now be used within the Closed pipeline to take bulk actions on closed tickets, including:
- Applying labels
- Moving tickets out of the Closed pipeline
- Assigning epics
Condensed view - a new way to view your board
Abstracts the majority of ticket information, removes spacing between tickets and increases the number of tickets viewable at a given time on the board.
You can read more about our new board in this blog post!
Please note: for the first version, drag & drop is enabled for top-level items, meaning you can reorder Projects, and Epics that aren't inside a Project.
Security Fixes
- Package security updates
- Updated supported cipher suites
- TLS 1.2 is now an minimum version for ZHE for VM
- Closed vulnerability that allowed attackers to discover URLs of uploaded files and images
Bug Fixes
- Embedded version of runc has been updated, resolving the bug with containerd logs filling up
- If a user accesses Zenhub and is not part of any repos, the button prompting them to create a repository no longer incorrectly redirects to github.com
Changes
- Added a new deployment to better manage sidekiq queues and improve live application updates
- Secondary, redundant swap has been removed
- Fixed scaling logic to handle atypical VM sizes (ex. 8x16)
- Mongo upgrade from 4.4.9 to 4.4.13 on ZHE for VM
- K3s upgraded to 1.21.11 on ZHE for VM
- K3s upgrades are now air-gapped and enforced
- Initial Zenhub air-gapped installation now working properly
- Chrome Extension updated to Manifest V3
Known Issues
Too many authentication failuresmay be reported when attempting to SSH into the VM, which can be caused by multiple SSH keys loaded in the connecting workstation's SSH agent. A workaround is present in the documentation.
VM Embedded Component Versions
| Component | Version |
|---|---|
| Ubuntu | 20.04.4 |
| K3s | v1.21.11+k3s1 |
| Kubernetes | v1.21.11 |
| Kustomize | v3.9.4 |
| Fluentd | v1.6-debian-1 |
| Postgresql | 11.16 |
| MongoDB | 4.4.13 |
| RabbitMQ | 3.8.31 |
| Redis | 6.2.7 |
| PgBouncer | 1.15.0 |
Important Upgrade Instructions for Administrators
Zenhub Enterprise for Virtual Machine
⚠️ NOTE: For the upgrade from ZHE 3.3 -> ZHE 3.4, the regular rollback steps cannot be used. Please perform a machine level snapshot prior to upgrading to use as a backup in case you need to revert back to ZHE 3.3 for any reason.
-
You must be running ZHE 3.3 to perform the upgrade to ZHE 3.4.
-
For users currently running Zenhub Enterprise 3.3, look for an email from our team which will include a download link for the 3.4.0 upgrade package. The upgrade process is detailed in our documentation.
Zenhub Enterprise for Kubernetes
- Some extra upgrade instructions have been added specifically for this release due to some database changes that accompany the application updates. Please follow the upgrade instructions below for this release:
1. Prepare
- You need to get the
kustomization.yamlyou configured to setup Zenhub - Perform a diff to make sure no outstanding changes are waiting to be applied
kustomize build . | kubectl diff -f-It should exit 0 and only display a warning of unused variables. If changes are pending, apply them before starting the upgrade process.
- Make a copy of your existing
kustomization.yamland keep it handy for the next step
2. Update kustomization.yaml
- Check out the
zenhub-enterpriserepository at the tag of this release - Populate the new
kustomization.yamlwith your existing configuration values
Be sure to replace any additional customized configuration (such as ingress, TLS configuration) with your original configuration from...
Zenhub Enterprise 3.1.3
ZenHub Enterprise 3.1.3
These release notes are for ZenHub Enterprise (On-Premise) Virtual Machine with GitHub Enterprise Server.
- For users currently running ZenHub Enterprise 2.44, you may migrate directly to 3.1.3 instead of an earlier 3.1 release.
- For all users using ZenHub on github.com, please check out our new feature announcements on our product changelog.
IMPORTANT: ZenHub Enterprise 3.1.3 supports the following GitHub Enterprise versions: 2.22, and 3.0
What's new in ZenHub Enterprise 3.1.3 since ZenHub Enterprise 3.1.2
Security Fixes
Bug Fixes
- Fixed issue with incompatible openshift package version that could cause problems with data backups, restores, migrations, and upgrades.
- Fixed air-gapped installation method.
- Removed secondary swap file.
Changes
- Increased the minimum disk requirement to 90GB.
Known Issues
Too many authentication failuresmay be reported when attempting to SSH into the VM, which can be caused by multiple SSH keys loaded in the connecting workstation's SSH agent. A workaround has been added to the documentation.- Environments migrated from ZHE 2.44 that have not used the same
CRYPTO_PASSwill see a blank page in the Milestones view on the web app. - File uploads in the web application (not extension) are limited to 1MB in size.
That's all for now! Stay tuned for more updates coming soon!
ZenHub Enterprise 3.3.3
These release notes are for ZenHub Enterprise for Virtual Machine and ZenHub Enterprise for Kubernetes.
- For all users using ZenHub on github.com, please check out our new feature announcements on our product changelog.
- For administrators planning upgrades, please refer to the section "Important Upgrade Instructions for Administrators".
IMPORTANT: ZenHub Enterprise 3.3.3 supports GitHub Enterprise versions: 3.3, 3.4
What's new in ZenHub Enterprise 3.3.3
Features
- No new features in this patch release.
Security Fixes
- Package security updates.
Bug Fixes
- Fixed Firefox extension installation for Firefox v100 and greater.
Changes
- No changes in this patch release.
Known Issues
Too many authentication failuresmay be reported when attempting to SSH into the VM, which can be caused by multiple SSH keys loaded in the connecting workstation's SSH agent. A workaround is present in the documentation.- The version of runc embedded in the K3s installation contains a logging bug which can potentially fill up containerd logs.
- 'Manage organizations' dashboard does not have dark-mode theming.
- The alignment of the license management options in the 'Manage organizations' dashboard is too close to the radio buttons.
- Partial username search does not return any users in the Team members section of the 'Manage organizations' dashboard, only an exact search works.
- When using the browser extension and logged into GitHub Enterprise as an administrator, the black enterprise version banner at the top of the page sits over ZenHub elements.
- If a user accesses ZenHub and is not part of any repos, the button prompting them to create a repository redirects to GitHub Cloud.
VM Embedded Component Versions
| Component | Version |
|---|---|
| Ubuntu | 20.04.4 |
| K3s | v1.20.13+k3s1 |
| Kubernetes | v1.20.13 |
| Kustomize | v3.9.4 |
| Fluentd | v1.6-debian-1 |
| Postgresql | 11.14 |
| MongoDB | 4.4.9 |
| RabbitMQ | 3.8 |
| Redis | 6.2 |
| PgBouncer | 1.15.0 |
Important Upgrade Instructions for Administrators
ZenHub Enterprise for Virtual Machine
⚠️ NOTE: Specifically for the upgrade from ZHE 3.2 -> ZHE 3.3, the regular rollback steps cannot be used. Please perform a machine level snapshot prior to upgrading to use as a backup in case you need to revert back to ZHE 3.2 for any reason.
-
You must be running either ZHE 3.2 or 3.3 to perform the upgrade to ZHE 3.3.3.
-
For users currently running ZenHub Enterprise 3.2 or 3.3, look for an email from our team which will include a download link for the 3.3.3 upgrade package. The upgrade process is detailed in our documentation.
ZenHub Enterprise for Kubernetes
- Some extra upgrade instructions have been added specifically for this release due to some database changes that accompany the application updates. Please follow the upgrade instructions below for this release:
1. Prepare
- You need to get the
kustomization.yamlyou configured to setup ZenHub - Perform a diff to make sure no outstanding changes are waiting to be applied
kustomize build . | kubectl diff -f-It should exit 0 and only display a warning of unused variables. If changes are pending, apply them before starting the upgrade process.
- Make a copy of your existing
kustomization.yamland keep it handy for the next step
2. Update kustomization.yaml
- Check out the
zenhub-enterpriserepository at the tag of this release - Populate the new
kustomization.yamlwith your existing configuration values
Be sure to replace any additional customized configuration (such as ingress, TLS configuration) with your original configuration from before as well.
- If you are using your own registry and not ZenHub's registry, upload the new images tagged with this release to your registry.
3. Database changes
- Run the script found in
k8s-cluster/update/zhe-upgrade.shvia the commands below:
If you use the ZenHub registry
cd update
./zhe-upgrade.sh yourNamespaceIf you use your own registry
cd update
./zhe-upgrade.sh yourNamespace yourRegistryName4. Application updates
In your new kustomization.yaml, update the cluster image tags to use the new images for this release:
If you are using your own registry, ensure that the newName fields are configured for that instead of ZenHub's
images:
- name: kraken-webapp
newName: us.gcr.io/zenhub-public/kraken-webapp
newTag: zhe-3.3.3
- name: kraken-extension
newName: us.gcr.io/zenhub-public/kraken-extension
newTag: zhe-3.3.3
- name: kraken-zhe-admin
newName: us.gcr.io/zenhub-public/kraken-zhe-admin
newTag: zhe-3.3.3
- name: raptor-backend
newName: us.gcr.io/zenhub-public/raptor-backend
newTag: zhe-3.3.3
- name: toad-backend
newName: us.gcr.io/zenhub-public/toad-backend
newTag: zhe-3.3.3
- name: sanitycheck
newName: us.gcr.io/zenhub-public/sanitycheck
newTag: zhe-3.3.3
- name: busybox
newName: docker.io/library/busybox
newTag: latest
- name: nginx
newName: docker.io/library/nginx
newTag: latest- Then perform a diff to check what the upgrade will do (this command must be run from the directory that contains your
kustomization.yaml
kustomize build . | kubectl diff -f-- If everything looks correct, you can deploy the cluster via:
kustomize build . | kubectl apply -f-5. Finalize
- Securely store the updated
kustomization.yaml
ZenHub Enterprise 3.3.2
These release notes are for ZenHub Enterprise for Virtual Machine and ZenHub Enterprise for Kubernetes.
- For all users using ZenHub on github.com, please check out our new feature announcements on our product changelog.
- For administrators planning upgrades, please refer to the section "Important Upgrade Instructions for Administrators".
IMPORTANT: ZenHub Enterprise 3.3.2 supports GitHub Enterprise versions: 3.3, 3.4
What's new in ZenHub Enterprise 3.3.2
Features
- No new features in this patch release.
Security Fixes
- Updated to Ubuntu 20.04.4 LTS.
- Package security updates.
Bug Fixes
- Fixed package version upgrade that could cause issues with upgrades, data backups, and data restores.
- Fixed file downloads on ZHE for K8s.
- Fixed release report data migration for upgrades from 3.2 to 3.3
Changes
- Improved logrotation of application logs for ZHE for VM.
- Updated websocket routing configuration for ZHE for K8s deployments, allowing for better performing horizontal application scaling in high load environments.
- Enhanced ZHE version compatibility check for ZHE for VM upgrades.
Known Issues
Too many authentication failuresmay be reported when attempting to SSH into the VM, which can be caused by multiple SSH keys loaded in the connecting workstation's SSH agent. A workaround is present in the documentation.- The version of runc embedded in the K3s installation contains a logging bug which can potentially fill up containerd logs.
- 'Manage organizations' dashboard does not have dark-mode theming.
- The alignment of the license management options in the 'Manage organizations' dashboard is too close to the radio buttons.
- Partial username search does not return any users in the Team members section of the 'Manage organizations' dashboard, only an exact search works.
- When using the browser extension and logged into GitHub Enterprise as an administrator, the black enterprise version banner at the top of the page sits over ZenHub elements.
- If a user accesses ZenHub and is not part of any repos, the button prompting them to create a repository redirects to GitHub Cloud.
VM Embedded Component Versions
| Component | Version |
|---|---|
| Ubuntu | 20.04.4 |
| K3s | v1.20.13+k3s1 |
| Kubernetes | v1.20.13 |
| Kustomize | v3.9.4 |
| Fluentd | v1.6-debian-1 |
| Postgresql | 11.14 |
| MongoDB | 4.4.9 |
| RabbitMQ | 3.8 |
| Redis | 6.2 |
| PgBouncer | 1.15.0 |
Important Upgrade Instructions for Administrators
ZenHub Enterprise for Virtual Machine
⚠️ NOTE: Specifically for the upgrade from ZHE 3.2 -> ZHE 3.3, the regular rollback steps cannot be used. Please perform a machine level snapshot prior to upgrading to use as a backup in case you need to revert back to ZHE 3.2 for any reason.
-
You must be running either ZHE 3.2.0, 3.2.1, or 3.3.0 to perform the upgrade to ZHE 3.3.2.
-
For users currently running ZenHub Enterprise 3.2 or 3.3.0, look for an email from our team which will include a download link for the 3.3.2 upgrade package. The upgrade process is detailed in our documentation.
ZenHub Enterprise for Kubernetes
- Some extra upgrade instructions have been added specifically for this release due to some database changes that accompany the application updates. Please follow the upgrade instructions below for this release:
1. Prepare
- You need to get the
kustomization.yamlyou configured to setup ZenHub - Perform a diff to make sure no outstanding changes are waiting to be applied
kustomize build . | kubectl diff -f-It should exit 0 and only display a warning of unused variables. If changes are pending, apply them before starting the upgrade process.
- Make a copy of your existing
kustomization.yamland keep it handy for the next step
2. Update kustomization.yaml
- Check out the
zenhub-enterpriserepository at the tag of this release - Populate the new
kustomization.yamlwith your existing configuration values
Be sure to replace any additional customized configuration (such as ingress, TLS configuration) with your original configuration from before as well.
- If you are using your own registry and not ZenHub's registry, upload the new images tagged with this release to your registry.
3. Database changes
- Run the script found in
k8s-cluster/update/zhe-upgrade.shvia the commands below:
If you use the ZenHub registry
cd update
./zhe-upgrade.sh yourNamespaceIf you use your own registry
cd update
./zhe-upgrade.sh yourNamespace yourRegistryName4. Application updates
In your new kustomization.yaml, update the cluster image tags to use the new images for this release:
If you are using your own registry, ensure that the newName fields are configured for that instead of ZenHub's
images:
- name: kraken-webapp
newName: us.gcr.io/zenhub-public/kraken-webapp
newTag: zhe-3.3.2
- name: kraken-extension
newName: us.gcr.io/zenhub-public/kraken-extension
newTag: zhe-3.3.2
- name: kraken-zhe-admin
newName: us.gcr.io/zenhub-public/kraken-zhe-admin
newTag: zhe-3.3.2
- name: raptor-backend
newName: us.gcr.io/zenhub-public/raptor-backend
newTag: zhe-3.3.2
- name: toad-backend
newName: us.gcr.io/zenhub-public/toad-backend
newTag: zhe-3.3.2
- name: sanitycheck
newName: us.gcr.io/zenhub-public/sanitycheck
newTag: zhe-3.3.2
- name: busybox
newName: docker.io/library/busybox
newTag: latest
- name: nginx
newName: docker.io/library/nginx
newTag: latest- Then perform a diff to check what the upgrade will do (this command must be run from the directory that contains your
kustomization.yaml
kustomize build . | kubectl diff -f-- If everything looks correct, you can deploy the cluster via:
kustomize build . | kubectl apply -f-5. Finalize
- Securely store the updated
kustomization.yaml
ZenHub Enterprise 3.3.0
These release notes are for ZenHub Enterprise for Virtual Machine and ZenHub Enterprise for Kubernetes.
- For all users using ZenHub on github.com, please check out our new feature announcements on our product changelog.
- For administrators planning upgrades, please refer to the section "Important Upgrade Instructions for Administrators".
IMPORTANT: ZenHub Enterprise 3.3 supports GitHub Enterprise versions: 3.2, 3.3
What's new in ZenHub Enterprise 3.3.0
Features
Planning poker
Team members can now estimate issues individually and record a history of who estimated what. No more guessing who was part of the process or where the estimate came from.
We've added the ability to optionally alert a teammate that they've been added to planning poker for an issue. This feature automatically posts an issue comment tagging a team mate which notifies them that an estimate is needed.
You can also request estimates from your whole team at once via Planning Poker Groups! When requesting estimates during a round of Planning Poker, users will be grouped based on your previous selections. This means you can choose your entire team in just one click rather than selecting them one-by-one.
Quick issue creation
A new [+] button has been added to the top of each of each of your pipelines to quickly create issues within the respective pipeline. Click, type, submit. It's as easy as that!
To quickly create an epic, click the new [+] button on any pipeline and then click on the issue icon to see it transform into an epic.
Remove epic start and end dates
You can now remove the start and end dates for an epic directly from the date selection widget.
Export and share roadmaps
You can now export roadmaps to an SVG file via the Share button.
GitHub Projects Importer
For those who want to break away from GitHub Projects and come over to ZenHub, you now have an easy way to import your project and issues over with just a couple of clicks.
Sprint Insights Beta
Right from your Board you’ll be able to: see ZenHub Sprint progress, understand changes in scope, see average velocity and compare to last period, add unfinished Issues to your next Sprint, and more.
A Toast to Completed Sprints
We've added a Sprint Completed toast that provides a short summary of your team's progress over the last sprint. Use this as a way to glean sprint information, update your team on progress or as a reminder to celebrate a completed sprint.
Dark mode has arrived in ZenHub!
Dark mode lovers attest to its ability to reduce eye strain in low light conditions. Most importantly, we think it happens to look especially snazzy! Available on both the ZenHub web app and the ZenHub browser extension for GitHub.
Enabling dark mode can be done in just one simple step, no matter where you use ZenHub!
- For those using the browser extension in GitHub, ZenHub’s dark mode will automatically update based on your GitHub preferences. In other words, if you use dark mode in GitHub, you’ll have dark mode in ZenHub!
- For those that use the web app, dark mode can be conveniently activated by clicking the up arrow on your profile on the bottom left, and toggling on dark mode. That’s it, you’ve got dark mode!
Security Fixes
- Updated to Ubuntu 20.04.3 LTS.
- Updated embedded Kubernetes in ZHE for VM.
- Updated embedded backend databases in ZHE for VM.
- Added TLS support for external MongoDB in ZHE for K8s.
Bug Fixes
- File uploads in the web application are no longer limited to 1MB in size.
- A page refresh is no longer needed to view ZenHub properties when opening a GitHub issue with the ZenHub browser extension installed with newer versions of GitHub Enterprise.
- Dragging PRs with long names on the Board no longer clips the previous issue.
- Two byte characters in input fields no longer prematurely entered.
- Increased pod liveness check start delay for ZenHub backend K8s pods, resolving rough pod startup.
Changes
- Increased default minimum disk size from 80GB to 90GB, increasing root filesystem from 20GB to 30GB for new installations.
- Fine tuned log rotation to decrease log sizes in ZHE for VM.
- Adding default backend to ingress.
- Optimized memory allocation for small deployments.
- Added
zhe-config --update-tlscommand to enable updating TLS certificates without a full application restart. - Added
zhe-config --update-licensecommand for updating your ZenHub license without bringing down the application.
Known Issues
Too many authentication failuresmay be reported when attempting to SSH into the VM, which can be caused by multiple SSH keys loaded in the connecting workstation's SSH agent. A workaround is present in the documentation.- The version of runc embedded in the K3s installation contains a logging bug which can potentially fill up containerd logs.
- 'Manage organizations' dashboard does not have dark-mode theming.
- The alignment of the license management options in the 'Manage organizations' dashboard is too close to the radio buttons.
- Partial username search does not return any users in the Team members section of the 'Manage organizations' dashboard, only an exact search works.
- When using the browser extension and logged into GitHub Enterprise as an administrator, the black enterprise version banner at the top of the page sits over ZenHub elements.
- If a user accesses ZenHub and is not part of any repos, the button prompting them to create a repository redirects to GitHub Cloud.
VM Embedded Component Versions
| Component | Version |
|---|---|
| Ubuntu | 20.04.3 |
| K3s | v1.20.13+k3s1 |
| Kubernetes | v1.20.13 |
| Kustomize | v3.9.4 |
| Fluentd | v1.6-debian-1 |
| Postgresql | 11.14 |
| MongoDB | 4.4.9 |
| RabbitMQ | 3.8 |
| Redis | 6.2 |
| PgBouncer | 1.15.0 |
Important Upgrade Instructions for Administrators
ZenHub Enterprise for Virtual Machine
⚠️ NOTE: Specifically for the upgrade from ZHE 3.2 -> ZHE 3.3, the regular rollback steps cannot be used. Please perform a machine level snapshot prior to upgrading to use as a backup in case you need to revert back to ZHE 3.2 for any reason.
-
You must be running either ZHE 3.2.0 or ZHE 3.2.1 to perform the upgrade to ZHE 3.3.0.
-
For users currently running ZenHub Enterprise 3.2.0 or 3.2.1, look for an email from our team which will include a download link for the 3.3.0 upgrade package. The upgrade process is detailed in our documentation.
ZenHub Enterprise for Kubernetes
- Some extra upgrade instructions have been added specifically for this release due to some database changes that accompany the application updates. Please follow the upgrade instructions below for this release:
1. Prepare
- You need to get the
kustomization.yamlyou configured to setup ZenHub - Perform a diff to make sure no outstanding changes are waiting to be applied
kustomize build . | kubectl diff -f-It should exit 0 and only display a warning of unused variables. If changes are pending, apply them before starting the upgrade process.
- Make a copy of your existing
kustomization.yamland keep it handy for the next step
2. Update kustomization.yaml
- Check out the
zenhub-enterpriserepository at the tag of this release
...
ZenHub Enterprise 3.2.1
These release notes are for ZenHub Enterprise for Virtual Machine and ZenHub Enterprise for Kubernetes.
- For all users using ZenHub on github.com, please check out our new feature announcements on our product changelog.
- For administrators planning upgrades, please refer to the section "Important Upgrade Instructions for Administrators".
IMPORTANT: ZenHub Enterprise 3.2 supports GitHub Enterprise versions: 2.22, 3.0, 3.1, and 3.2
What's new in ZenHub Enterprise 3.2.1
Features
- None
Security Fixes
- None
Bug Fixes
- Fixed race condition that would occur during a restore from database backups, which also affected upgrades from ZHE 3.1 to ZHE 3.2.0
- Upgrade bundle for VM now performs more preliminary checks to ensure the environment meets upgrade requirements
Changes
- Increased timeout duration for backups and restores to better handle a large amount of data
- URL redirect setup to point IP requests to the hostname
Known Issues
Too many authentication failuresmay be reported when attempting to SSH into the VM, which can be caused by multiple SSH keys loaded in the connecting workstation's SSH agent. A workaround is present in the documentation.- File uploads in the web application (not extension) are limited to 1MB in size.
- On more recent versions of GitHub Enterprise, when viewing a GitHub issue from the GitHub issues list the ZenHub extension may require a page refresh to display ZenHub props such as Estimate and Epic
VM Embedded Component Versions
| Component | Version |
|---|---|
| Ubuntu | 20.04.2 |
| K3s | v1.20.8+k3s1 |
| Kubernetes | v1.20.8 |
| Kustomize | v3.9.4 |
| Fluentd | v1.6-debian-1 |
| Postgresql | 11.12.0 |
| MongoDB | 4.4.6 |
| RabbitMQ | 3.8 |
| Redis | 6.2 |
| PgBouncer | 1.15.0 |
Important Upgrade Instructions for Administrators
ZenHub Enterprise for Virtual Machine
⚠️ NOTE: Specifically for the upgrade from ZHE 3.1 -> ZHE 3.2.1, the regular rollback steps cannot be used. Please perform a machine level snapshot prior to upgrading to use as a backup in case you need to revert back to ZHE 3.1 for any reason.
- For users currently running ZenHub Enterprise 2.44, you must first migrate to 3.1.1 prior to upgrading to 3.2.1
- For users currently running ZenHub Enterprise 3.1.0 or 3.1.1, look for an email from our team which will include a download link for the 3.2.1 upgrade package. The upgrade process is detailed in our documentation.
If you have previously performed a restore while using ZenHub Enterprise 3.1 (via zhe-config --restore), we have released a patch file that must be applied before performing the upgrade to ZenHub Enterprise 3.2.1. Follow the steps below to apply and then upgrade (we recommend all customers perform steps 1 and 2 before the upgrade):
- Download the patch to your VM
- Run the patch via
bash zhe_31x_restore_patch.run - Perform a restore from a snapshot using
zhe-config --restore - Take a machine level backup of the VM
- Run the 3.2.1 upgrade as per our documentation
ZenHub Enterprise for Kubernetes
- Upgrading from 3.2.0 -> 3.2.1 is possible, but not necessary. No changes have been made to the app, as this release only contains fixes to the upgrade path for ZenHub for VM. If you would still like to upgrade your ZenHub cluster from 3.2.0 to 3.2.1, you can follow the regular application upgrade steps.
ZenHub Enterprise 3.2.0
These release notes are for ZenHub Enterprise for Virtual Machine and ZenHub Enterprise for Kubernetes.
- For all users using ZenHub on github.com, please check out our new feature announcements on our product changelog.
- For administrators planning upgrades, please refer to the section "Important Upgrade Instructions for Administrators".
IMPORTANT: ZenHub Enterprise 3.2 supports GitHub Enterprise versions: 2.22, 3.0 and 3.1
What's new in ZenHub Enterprise 3.2.0
Features
Select all in a pipeline
Today we're thrilled to ship a feature that will surely help with sprint planning and organizing your Board. Once in multi-select mode, you can now select up to 50 Issues in a pipeline!
With this initial release, we're limiting the amount of selected Issues to 50 as we scale up and improve the queuing system to handle a greater number of requests.
A large performance improvement
We released another large piece of our new backend, "Raptor". We saw performance improvements across the app, up to 96%! With this release, we've also removed the 500 closed Issue limit (self-imposed to stay within GitHub's rate limit) on both the Cumulative flow and Control chart. These two charts have also been updated from being able to query a maximum of 6 months in the past to 24 months!
New tutorials and customized onboarding
ZenHub’s new tutorials and onboarding experience gives new users the basics, and helps existing users level up.
We’ll show you in-app tutorials personalized for you, whether you’re a developer focused on committing and tracking your code changes, or a project manager looking for a better way to prioritize and collaborate on your work.
Looking to brush up on your ZenHub knowledge? Access our new personalized tutorials via the “View Tutorials” section in your sidebar.
Burndown Chart bug fix
The ideal completion slope of Burndown chart was a little bit too aggressive at the start of your sprint vs the end. Maybe we wanted you to push hard in the first half to enjoy a more relaxed second half or it was a math error on our side. Who knows but the Burndown chart now shows an equal ideal completion slope in the first half vs the second half (PS. It was a math error).
Brand new epic page
Our epic page has been revamped to offer a brand new design and much needed usability improvements. You can now work right out of your epic page and:
- get issue insights
- see estimates, labels and assignees for all your issues without the extra clicks
- use issue options to remove issues from the epic, close issues or set as high priority
- rearrange your issues (send to top/send to bottom)
Automated Workflows 🎉
We have launched Automated Workflows as a way for you to automate hand-offs, create aggregated Board views, and clean up Issue statuses and pipelines!
You will see detailed timeline events when an Issue is moved due to an automation. See who, what, where, and when an Issue was moved and be able to track it through your workflow.
Heads up! Board notifications will display when moving Issues between pipelines. You will now see where an Issue is moved in other Workspaces based connected through your workflow.
We've included in-context prompts when creating a new Workspace or manually moving Issues in another Workspace (PS. If you're still manually moving Issues in other Workspaces... click the "Workflows" link on the sidebar!)
More updates to Epics
Roadmaps and Epics start and end dates can now be set from the Epic page itself! Once dates have been set, a new [View on Roadmap] button will appear below the Issue list in order to see how the Epic fits within your team's bigger picture.
Authentication updates for the ZenHub browser extension
If you've needed to refresh your GitHub authentication tokens on the extension lately, you may have noticed a change in the process. Re-authorizing is now done through a small popup in order to keep you in context with what you're working on.
Load only the Issues that relate to your team
With the new Workspace Filter, your Board will only load Issues with the labels you’ve selected. All other Issues will still exist in the repo but won't show up in this Workspace, speeding up load times and reducing clutter.
Add a Workspace filter in the Edit Workspace modal in your sidebar. Keep in mind, unlike the regular Board filters — which only filter your view of the Board — Workspace Filter applies for everyone in your team.
Automatically sort Issues when setting up a new Workspace
It's like the Sorting Hat of Issues - except it's logic-powered, not magic-powered.
When you create a new Workspace, Issues will automatically be sorted into relevant Pipelines, reducing the amount of setup time required. Right now, Issues will be sorted according to these triggers:
- Issues in the current Milestone will be moved to
Sprint Backlog - Issues with no recent activity will be moved to
Icebox - Issues with connected PRs will be moved to
In progress
This will be a one-time sort, meaning Issues will only be moved once during the initial Workspace setup.
Burn Pipeline dropdown update
The Burn Pipeline dropdown on the Burndown report now selects all pipelines after the selection to better follow the workflow of sequential pipelines.
Badge and label style changes
All badges and labels have been updated to match GitHub’s UI. Round corners are in again!
Closed pipeline enhanced
Issue ←→ PR connections are now visible across all pipelines, including the Closed pipeline.
A plethora of small updates
- Videos can be uploaded and viewed in issues and comments in the ZenHub webapp (support for the ZenHub extension is in progress).
- To help you get up and running faster with a new Workspace, issues updated in the last 30 - 90 days will automatically be moved to the Sprint Backlog (note: this only happens the first time you create a Workspace).
- When connecting a PR to an issue, the most recent issues you worked on will appear in the dropdown first.
- Updated estimate selector in the Issue sidebar to make it easier to quickly estimate Issues
- Added more filters to the Board by default (from 6 to 7)
- Updated background colour for title + description inputs when editing an Issue
- Added error state when an Issue doesn’t exist in the Workspace
- Show search results (Issue and Story point count) during keyword search
See PR reviewers and review status on the Board
ZenHub now shows reviewers and review status on PR cards! Take a look at any PR card on your board and you’ll see the avatar of the reviewer(s), and a colourful dot that quickly indicates the status.
- Red - requested changes
- Green - approved changes
- Grey - left review comments
- Yellow - pending review
ZenHub Sprints are here!
ZenHub Sprints launched earlier this week so here's the TL;DR of what changed.
- Sprints are scoped to a Workspace whereas Milestones are tied to a repo
- Sprints are automatically created based on your set schedule
- Sprints can be automatically built from your backlog based on velocity
- Incomplete issues can be automatically rolled over to the next Sprint
- Issues can now live in more than one Sprint, keeping current and past velocity reporting accurate (vs always showing 100% completion when moving inco...
ZenHub Enterprise 3.1.2
ZenHub Enterprise 3.1.2
These release notes are for ZenHub Enterprise (On-Premise) Virtual Machine with GitHub Enterprise Server.
- For users currently running ZenHub Enterprise 2.44, you may migrate directly to 3.1.2 instead of 3.1.1 or 3.1.0
- For users currently running ZenHub Enterprise 3.1.0 or 3.1.1, look for an email from our team which will include a download link for the 3.1.2 upgrade package. The upgrade process is detailed in our documentation.
- For all users using ZenHub on github.com, please check out our new feature announcements on our product changelog.
IMPORTANT: ZenHub Enterprise 3.1.2 supports the following GitHub Enterprise versions: 2.22, and 3.0
What's new in ZenHub Enterprise 3.1.2 since ZenHub Enterprise 3.1.1
Security Fixes
Bug Fixes
- MongoDB restore process for 2.44 -> 3.1.x migration now accounts for unsafe index values which caused migration failures for some customers.
Changes
- Integrated the 31x_restore_patch into 3.1.2. The patch does not need to be applied on 3.1.2.
Known Issues
Too many authentication failuresmay be reported when attempting to SSH into the VM, which can be caused by multiple SSH keys loaded in the connecting workstation's SSH agent. A workaround has been added to the documentation.- Environments migrated from ZHE 2.44 that have not used the same
CRYPTO_PASSwill see a blank page in the Milestones view on the web app. - File uploads in the web application (not extension) are limited to 1MB in size.
That's all for now! Stay tuned for more updates coming soon!
v3.1.1
ZenHub Enterprise 3.1.1
These release notes are for ZenHub Enterprise (On-Premise) Virtual Machine with GitHub Enterprise Server.
- For users currently running ZenHub Enterprise 2.44, you may migrate directly to 3.1.1 instead of 3.1.0
- For users currently running ZenHub Enterprise 3.1.0, look for an email from our team which will include a download link for the 3.1.1 upgrade package. The upgrade process is detailed in our documentation.
- For all users using ZenHub on github.com, please check out our new feature announcements on our product changelog.
IMPORTANT: ZenHub Enterprise 3.1.1 supports the following GitHub Enterprise versions: 2.22, and 3.0
What's new in ZenHub Enterprise 3.1.1 since ZenHub Enterprise 3.1.0
Security Fixes
- Hide nginx version in response headers
Bug Fixes
- Fixed an issue that prevented the upload of files and images through the ZenHub web app
Changes
- Added VM size recommendations
- Deployment now scales itself to fit the VM size in which it's deployed
- Users can resize the deployment after resizing the VM by running
zhe-config --reload - Improved consistency and added missing content to the documentation in virtual-machine/README.md
- Added a feature to
zhe-configto import container images in the event they're deleted from containerd - Disk utilization threshold to begin kubelet image garbage collection increased from 85% to 95%
- Disk utilization threshold to stop kubelet image garbage collection increased from 80% to 85%
Known Issues
Too many authentication failuresmay be reported when attempting to SSH into the VM, which can be caused by multiple SSH keys loaded in the connecting workstation's SSH agent. A workaround has been added to the documentation.- Environments migrated from ZHE 2.44 that have not used the same
CRYPTO_PASSwill see a blank page in the Milestones view on the web app. - File uploads in the web application (not extension) are limited to 1MB in size.
That's all for now! Stay tuned for more updates coming soon!