Skip to content

Releases: jdoiro3/mkdocs-multirepo-plugin

Release v0.4.12

21 Oct 12:10
4022398
Compare
Choose a tag to compare

Changes in this Release

  • Fixed use of GithubAccessToken environment variable so that the sparse clone now uses the correct token.

Release v0.4.11

20 Oct 14:10
15a023f
Compare
Choose a tag to compare

Changes in this Release

  • Added a specific GithubAccessToken environment variable that allows usage of the plugin with GitHub Apps-generated access tokens and personal access tokens.
  • Fixed edit urls for imported repos where the the Mkdocs edit_uri and repo_url aren't set, and the Multirepo edit_uri for an imported repo isn't set. Note that the edit url for imported repos hasn't been robustly tested yet.

Slugify Section Names and Changed Import Param Separator

22 Jun 13:07
e5e60a9
Compare
Choose a tag to compare

Breaking Changes

  • Previously, you would separate config values in an !import statement using multiple ampersands (&). Now, the !import statement will follow general URL syntax, where the url and query string (config values) is separated by one question mark (?) and then each config section is separated by an ampersand. Below is an example !import statement.
    '!import {url}?branch={branch}&docs_dir={path}&multi_docs={True | False}&config={filename}.yml'

Other Changes

  • Section names are slugified for clear urls (see PR #28 and Issue #24 for details). This most likely will change in future releases.

0.3.6

10 May 19:38
e75c8af
Compare
Choose a tag to compare

Added ability to clone git repos in github workflows with PAT authentication.

v0.3.5

08 Apr 18:30
Compare
Choose a tag to compare

Fixed bugs #15 and #16.

v0.3.3

01 Apr 16:17
38ef17c
Compare
Choose a tag to compare

Additions

Previously, !import statements could only be included within top level sections in the nav. Now, the !import statement can be located anywhere in the nav.

nav:
  - Home: index.md
  - microservice:
      - Home: test.md
      - ServiceA: '!import https://github.com/jdoiro3/mkdocs-multirepo-demoRepo1?branch=main'
      - ServiceB: '!import https://github.com/jdoiro3/mkdocs-multirepo-demoRepo1?branch=main'

v0.3.2

19 Mar 11:42
59522bb
Compare
Choose a tag to compare

Additions

  • Users can now store the multirepo config file for an imported repo either within the docs directory or the root directory. If the name of the config isn't mkdocs.yml, it can also be specified via the new url parameter: ?config={filename}.yml.

Changes

  • Fixed the issue where build outputs contained configuration files (see issue #9 for details).

v0.3.1

03 Mar 16:43
Compare
Choose a tag to compare

Changes

  • Section names with spaces were causing two directories to be created when the version of git was old (i.e., sparse_clone_old.sh was run).

v0.3.0

21 Feb 23:09
584d1f5
Compare
Choose a tag to compare

Additions

  • Added the ability to call mkdocs serve in an imported repo

v0.2.9

19 Feb 17:02
Compare
Choose a tag to compare

Additions

  • Added support for macOS