Upgrading Docsy

Upgrade and release process for the Docsy module and dependencies

To upgrade Docsy, choose the latest version from the Releases section of the Docsy repo.

  1. Update go.mod
module github.com/pfd/cool-docs

go 1.18

require github.com/google/docsy v0.7.1 // indirect

You can put your own repo, and go version, but it’s probably best to use the Docsy dependencies and Bootstrap version that is defined in the latest release.

  1. Update dependencies

Update the latest dependencies, if necessary, in package.json.

  "devDependencies": {
    "autoprefixer": "^10.4.14",
    "postcss": "^8.4.24",
    "postcss-cli": "^10.1.0"
  }
  1. Update config

If you’re updating the minimum Hugo version, reflect that in hugo.yml.

module:
  hugoVersion:
    extended: true
    min: 0.113.0
  imports:
    - path: github.com/google/docsy
      disable: false
    - path: github.com/google/docsy/dependencies
      disable: false
  1. Run some commands
npm install
hugo mod tidy
If you see conflicting versions of dependencies in `go.sum`, try deleting all the contents of the file. It will repopulate when you build the site in the next step.
  1. Build your site!
hugo

If all goes well, your go.sum file should reflect the latest dependencies. Commit and push your changes to your repo.