gdk subcommand to update gitlab branch checkout
Overview
We have a documentation that lists steps required to update Gitlab checkout. Could we make these steps a gdk
subcommand instead?
I got burned recently by not following the docs precisely. I have created MR that clarifies the docs a bit more to prevent mishaps like this, but any manual procedure is error prone if human needs to follow it.
I am not sure if gdk install gitlab_repo=https://my-fork
already does what I describe below - if it does, could we update the documentation to point to it instead listing the steps?
Switching gitlab branches is pretty common operation, and it takes time for any first-time user to find the documentation and then set up aliases. Compared to this, simple gdk help
followed by e.g. gdk gl-branch
would be much easier and more efficient way to support users.
This subcommand would encompass:
- starting gdk if it is not already running
- reinstall dependencies
- calling the migration script
- restarting gdk, veryfying that it started correctly
- waiting for gdk to boot/get ready (optional)
Impacted categories
The following categories relate to this issue:
-
gdk-reliability - e.g. When a GDK action fails to complete. -
gdk-usability - e.g. Improvements or suggestions around how the GDK functions. -
gdk-performance - e.g. When a GDK action is slow or times out.
Steps to replicate (optional)
Proposal (optional)
Environment (optional)
- Operating system name:
<!-- output of `uname -a` command -->
- Architecture:
<!-- output of `arch` command -->
- The contents of your
gdk.yml
(if any) - Ruby version:
<!-- output of `ruby --version` command -->
- GDK version:
<!-- output of `git rev-parse --short HEAD` command -->