mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-11-14 19:07:41 +01:00

added instructions for checking out and updating specific releases (#6095 )

* added instructions for checking out specific releases and also moved the bit about $GH_TOKEN to a place above
the pip install instructions
* separated out update instructions, revised git instructions
* bumped version number that insiders is based on
* removed --upgrade from update command
* made insiders changelog a section
* changed instructions for upgrading via git

2023-09-28 10:42:28 -04:00

2.4 KiB

Raw Blame History

How to upgrade

When upgrading Insiders, you should always check the version of Material for MkDocs which makes up the first part of the version qualifier, e.g., Insiders 4.x.x is currently based on 9.x.x:

9.x.x-insiders-4.x.x

If the major version increased, it's a good idea to consult the upgrade guide and go through the steps to ensure your configuration is up to date and all necessary changes have been made.

Depending on how you installed and what you want to upgrade to you need to run different commands:

=== "pip upgrade to release"

If you installed Insiders via `pip` and you want to upgrade to a
specific release, pick the tag from the [list of tags] and replace 
the tag at the end of the URL of the command given below:

```
pip install --upgrade git+https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git@9.4.2-insiders-4.42.0
```

=== "pip upgrade to latest development"

If you installed Insiders via `pip` and want to upgrade to the
latest development version, run:

```
pip install --upgrade git+https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git
```

=== "git upgrade"

If you installed Insiders via `git`, you will first need to check
out the version you want to install into your workspace. After
this is done, you can run `pip` to install that version.

First, make sure that your local clone is up-to-date with the
upstream repository by running `git pull`.

You can look up the tags using `git tag --sort -refname` or you
can consult the [list of tags]. Then, checkout the tag you want to
use by replacing the one given in the command below (twice)and running 
it from your workspace[^detached]:
  
  [^detached]:
    The `--detach` argument serves to tell `git` that you are ok to
    have your workspace in the [detached head] state, which is
    perfectly fine to have here.
    
  [detached head]: https://www.git-tower.com/learn/git/faq/detached-head-when-checkout-commit/

``` 
cd mkdocs-material 
git checkout --detach tags/9.4.2-insiders-4.42.0 
```

Now, change back to the parent directory in which your Git
repository lives and run `pip`:

```
cd .. 
pip install -e mkdocs-material
```

2.4 KiB Raw Blame History

How to upgrade

2.4 KiB

Raw Blame History