Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
64 changes: 64 additions & 0 deletions .github/workflows/main.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
name: Build Percona Backup for MongoDB docs
on:
push:
branches:
- main

jobs:
build:
name: Deploy docs
runs-on: ubuntu-latest
permissions:
contents: write

steps:
#Pull the latest changes
- name: Checkout code
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
fetch-depth: 0 # fetch all commits/branches
#Prepare the env
- name: Set up Python
uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0
with:
python-version: '3.x'

#Extract release from YAML
- name: Extract release from variables
run: |
RELEASE=$(grep '^release:' variables.yml | awk '{print $2}' | tr -d "'")
echo "RELEASE=$RELEASE" >> $GITHUB_ENV
# PRUNED_VERSION=$(grep '^pruned_version:' variables.yml | awk '{print $2}' | tr -d "'")
# echo "PRUNED_VERSION"=$"PRUNED_VERSION" >> $GITHUB_ENV


#Set up MkDocs
- name: Install MkDocs
run: |
python -m pip install --upgrade pip
pip install wheel
if [ -f requirements.txt ]; then pip install -r requirements.txt; fi

# Configure git auth right before it's needed, scoped to this checkout only,
# so the credential isn't live on disk for the earlier setup steps.
- name: Configure git
env:
ROBOT_TOKEN: ${{ secrets.ROBOT_TOKEN }}
run: |
git config --local http.https://github.com/.extraheader "AUTHORIZATION: basic $(printf '%s' "x-access-token:${ROBOT_TOKEN}" | base64 -w0)"
git config user.name "GitHub Action"
git config user.email "github-action@users.noreply.github.com"

# Deploy docs
- name: Deploy docs
env:
MKDOCS_GIT_COMMITTERS_APIKEY: ${{ secrets.ROBOT_TOKEN }}
run: |
mike deploy $RELEASE -u latest -b publish -p
mike set-default latest -b publish -p
# mike delete $PRUNED_VERSION -b publish -p

# Drop the credential as soon as it's no longer needed
- name: Clear git credentials
if: always()
run: git config --local --unset-all http.https://github.com/.extraheader || true
38 changes: 0 additions & 38 deletions .github/workflows/main.yml

This file was deleted.

38 changes: 38 additions & 0 deletions .github/workflows/vale.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: Check docs with Vale
on:
pull_request:
branches:
- main

jobs:
vale:
name: runner / vale
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
fetch-depth: 0

# Configure git
- name: Configure git
env:
ROBOT_TOKEN: ${{ secrets.ROBOT_TOKEN }}
run: |
git config --global url."https://percona-platform-robot:${ROBOT_TOKEN}@github.com".insteadOf "https://github.com"
git config user.name "GitHub Action"
git config user.email "github-action@users.noreply.github.com"
git config user.password "${ROBOT_TOKEN}"
echo "GIT_USER=percona-platform-robot:${ROBOT_TOKEN}" >> $GITHUB_ENV

# Run check
- name: reviewdog
uses: errata-ai/vale-action@reviewdog
with:
vale_flags: "--glob=*.md"
# fail_on_error: true
reporter: github-check
env:
# Required, set by GitHub actions automatically:
# https://docs.github.com/en/actions/security-guides/automatic-token-authentication#about-the-github_token-secret
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Empty file added .nojekyll
Empty file.
4 changes: 2 additions & 2 deletions _resourcepdf/overrides/main.html
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@
{% endif %}
<meta property="og:type" content="website" />
<meta property="og:title" content="{{ title }}" />
<meta property="og:image" content="https://docs.percona.com/percona-backup-mongodb/_images/mongodb.png" />
<meta property="og:url" content="https://docs.percona.com/percona-backup-mongodb/" />
<meta property="og:image" content="https://docs.percona.com/percona-backup-mongodb/latest/_images/mongodb.png" />
<meta property="og:url" content="https://docs.percona.com/percona-backup-mongodb/latest/index.html" />
{% endblock %}

{% block site_nav %}
Expand Down
4 changes: 4 additions & 0 deletions mkdocs-base.yml
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,10 @@ extra_javascript:
- js/consent.js
- js/rating.js

extra:
version:
provider: mike

markdown_extensions:
abbr: {}
attr_list: {}
Expand Down
Loading