OpenSourceArk/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-06-14 11:52:32 +03:00
Code Issues Packages Projects Releases Wiki Activity

Updated GitLab publishing guide (#3393)

Browse Source 
Default branch for GitLab is main and no more master
This commit is contained in:
Franck CHAMBON 2021-12-27 13:47:22 +01:00 committed by GitHub
parent e1cf04345c
commit 8169e7f7c8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/publishing-your-site.md
View File

@ -126,8 +126,9 @@ contents:
image: python:latest image: python:latest
pages: pages:
stage: deploy stage: deploy
only: only: # (1)!
- master - master
- main
script: script:
- pip install mkdocs-material - pip install mkdocs-material
- mkdocs build --site-dir public - mkdocs build --site-dir public
@ -136,15 +137,19 @@ contents:
- public - public
``` ```
1. At some point, GitLab renamed `master` to `main`. If your default branch
is named `master`, you can safely remove `main`, vice versa.
=== "Insiders" === "Insiders"
``` yaml ``` yaml
image: python:latest image: python:latest
pages: pages:
stage: deploy stage: deploy
only: only: # (1)!
- master - master
script: # (1)! - main
script: # (2)!
- pip install git+https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git - pip install git+https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git
- mkdocs build --site-dir public - mkdocs build --site-dir public
artifacts: artifacts:
@ -152,7 +157,10 @@ contents:
- public - public
``` ```
1. Remember to set the `GH_TOKEN` environment variable to the value of your 1. At some point, GitLab renamed `master` to `main`. If your default branch
is named `master`, you can safely remove `main`, vice versa.
2. Remember to set the `GH_TOKEN` environment variable to the value of your
[personal access token] when deploying [Insiders], which can be done [personal access token] when deploying [Insiders], which can be done
using [masked custom variables]. using [masked custom variables].