You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We need to specifically reference the old CLI name in the upgrading
guide, so turn off the linting rule that disallows referencing it.
Also revert major version number bump in the GitHub action.
Copy file name to clipboardExpand all lines: docs/resources/upgrading.rst
+12-4
Original file line number
Diff line number
Diff line change
@@ -9,14 +9,22 @@ With the release of Gel v6, we have introduced a number of changes that affect y
9
9
CLI
10
10
===
11
11
12
-
For a few versions we've been shipping an alias to the ``edgedb`` CLI named ``gel`` as we've been working on the rename. For the most part, you can now just use ``gel`` instead of ``edgedb`` as the CLI name. Make sure you are using the latest version of the CLI by running ``gel cli upgrade``. If you see a note about not being able to upgrade, you can try running ``edgedb cli upgrade`` and then after that ``gel cli upgrade``.
12
+
.. lint-off
13
+
14
+
For a few versions we've been shipping an alias to the ``edgedb`` CLI named ``gel`` as we've been working on the rename. For the most part, you can now just use ``gel`` instead of ``edgedb`` as the CLI name. Make sure you are using the latest version of the CLI by running :gelcmd:`cli upgrade`. If you see a note about not being able to upgrade, you can try running ``edgedb cli upgrade`` and then after that :gelcmd:`cli upgrade`.
13
15
14
16
Don't forget to update any scripts that use the ``edgedb`` CLI to use ``gel`` instead.
15
17
18
+
.. lint-on
19
+
16
20
Project Configuration File
17
21
==========================
18
22
19
-
Gel CLI and client libraries use a configuration file configure various things about your project, such as the location of the schema directory, and the target version of the Gel server. Previously, this file was named ``edgedb.toml``, but it is now named ``gel.toml``.
23
+
.. lint-off
24
+
25
+
Gel CLI and client libraries use a configuration file configure various things about your project, such as the location of the schema directory, and the target version of the Gel server. Previously, this file was named ``edgedb.toml``, but it is now named |gel.toml|.
26
+
27
+
.. lint-on
20
28
21
29
In addition to the name change, we have also renamed the TOML table for configuring the server version from ``[edgedb]`` to ``[instance]``.
22
30
@@ -101,7 +109,7 @@ If you're using a hosted instance on Gel Cloud, you can upgrade your instance by
101
109
Local instances
102
110
---------------
103
111
104
-
If you have local instances that you've intialized with the CLI using ``edgedb project init``, you can upgrade them easily with the CLI.
112
+
If you have local instances that you've intialized with the CLI using :gelcmd:`project init`, you can upgrade them easily with the CLI.
105
113
106
114
.. code-block:: bash
107
115
@@ -168,6 +176,6 @@ We publish a GitHub action for accessing a Gel instance in your GitHub Actions w
0 commit comments