From a1175cdcdf14be26d7894c52c20121e664556099 Mon Sep 17 00:00:00 2001 From: James Panther <4462786+jpanther@users.noreply.github.com> Date: Thu, 3 Feb 2022 14:53:57 +1100 Subject: [PATCH] =?UTF-8?q?=F0=9F=90=9B=20Add=20v2=20to=20go=20path?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- exampleSite/content/docs/installation.md | 2 +- exampleSite/content/docs/version-2/upgrade/index.md | 6 +++--- go.mod | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/exampleSite/content/docs/installation.md b/exampleSite/content/docs/installation.md index c35126b2..936c20ec 100644 --- a/exampleSite/content/docs/installation.md +++ b/exampleSite/content/docs/installation.md @@ -65,7 +65,7 @@ This method is the quickest and easiest for keeping the theme up-to-date. Hugo u ```toml [[imports]] - path = "github.com/jpanther/congo" + path = "github.com/jpanther/congo/v2" ``` 4. Start your server using `hugo server` and the theme will be downloaded automatically. diff --git a/exampleSite/content/docs/version-2/upgrade/index.md b/exampleSite/content/docs/version-2/upgrade/index.md index e9222b0e..350d0404 100644 --- a/exampleSite/content/docs/version-2/upgrade/index.md +++ b/exampleSite/content/docs/version-2/upgrade/index.md @@ -30,14 +30,14 @@ The process for upgrading Congo will depend on how you include the theme in your ### Upgrade using Hugo -Hugo makes updating modules super easy. Simply change into your project directory and execute the following command: +To upgrade a go module to a new major release, the `modules.toml` and `go.mod` files need to be updated. In each file, update the path to the theme from `github.com/jpanther/congo` to `github.com/jpanther/congo/v2`. + +Then change into your project directory and execute the following command: ```shell hugo mod get -u ``` -Hugo will automatically upgrade any modules that are required for your project. It does this by inspecting your `module.toml` and `go.mod` files. If you have any issues with the upgrade, check to ensure these files are still configured correctly. - Once the theme has been upgraded, continue to the [next section](#step-3-theme-configuration). ### Upgrade using git diff --git a/go.mod b/go.mod index c3b624da..b3f1e7f7 100644 --- a/go.mod +++ b/go.mod @@ -1,3 +1,3 @@ -module github.com/jpanther/congo +module github.com/jpanther/congo/v2 go 1.16