Skip to content

Update the docs about how to update existing versions #298

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
thatbudakguy merged 1 commit into from
Feb 19, 2026
Merged

Update the docs about how to update existing versions #298

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,10 +56,10 @@ Note that as of [this pull request](https://github.com/geoblacklight/geoblacklig

Each version is kept in a separate directory named after the version number, e.g. `4.x`, `5.x`, etc. Versions also have "aliases", which are names that point to specific versions. These are implemented as symlinks that point to a particular version directory. Currently, we only use the `latest` alias.

To publish a new version of whatever the `latest` alias currently points to, on the `main` branch, you would run:
To publish a new version of the docs for version 5, on the `main` branch, you would run:

```sh
mike deploy --push latest
mike deploy --push 5.x
```

If a new version is being created and it should become the new `latest`, on the `main` branch, you would instead run:
Expand All @@ -71,7 +71,7 @@ mike deploy --push <new_version> --update-aliases latest
To update the docs for a previous version, you need to be on the branch corresponding to that version (e.g. `4.x` branch for version `4.x`), and then run:

```sh
mike deploy --push <version>
mike deploy --push <old_version>
```

Each version directory contains an entirely separate copy of the following:
Expand Down