Skip to content
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

Jump to bottom

deploy docs to dj-stripe.github.io with version support #2058

Merged
merged 1 commit into from
May 11, 2024
Merged

deploy docs to dj-stripe.github.io with version support #2058

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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
45 changes: 37 additions & 8 deletions .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,40 +5,69 @@ on:
branches:
- "master"
# Push events to branches matching "stable/*"
- "stable/.+"
- "stable/*"
abe-101 marked this conversation as resolved.
Show resolved Hide resolved

workflow_dispatch: # to trigger manually

env:
POETRY_VERSION: "1.2.2"
POETRY_VIRTUALENVS_IN_PROJECT: "1"
LATEST_STABLE_BRANCH: "stable/2.7"
DOCS_REPO: "dj-stripe.github.io"
OWNER: "dj-stripe" # if you forked the repo, change this to your gh username
SOURCE_REPO: "dj-stripe"


jobs:
deploy:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4
- name: Checkout source repo
uses: actions/checkout@v4

- name: Checkout documentation repo
uses: actions/checkout@v4
with:
repository: "${{ env.OWNER }}/${{ env.DOCS_REPO }}"
path: ./${{ env.DOCS_REPO }}
token: ${{ secrets.GH_PAT }} # Token needed to push site to gh-pages branch


- uses: ./.github/install_poetry_action
with:
POETRY_VERSION: ${{ env.POETRY_VERSION }}
python_version: "3.12"

- name: Copy docs and configuration from source to documentation repo
run: |
cp -r pyproject.toml mkdocs.yml docs tests ${{ env.DOCS_REPO }}/
cd ${{ env.DOCS_REPO }}
sed -i 's|name = "dj-stripe"|name = "dj-stripe-docs"|' pyproject.toml
sed -i 's|include = "djstripe"|include = "../djstripe"|' pyproject.toml
poetry add ../../dj-stripe

- name: Install dependencies
run: poetry install --with docs
run: |
cd ${{ env.DOCS_REPO }}
poetry install --with docs

- name: Configure git user to make commit
run: |
git config user.name "dj-stripe commit bot"
git config user.email "admin@djstripe.dev"
git config --global user.name "dj-stripe commit bot"
git config --global user.email "admin@djstripe.dev"

- name: Fetch gh-pages remote changes (if any)
run: git fetch origin gh-pages --depth=1
run: |
cd ${{ env.DOCS_REPO }}
git fetch origin gh-pages --depth=1

- name: Deploy (and Update) docs for the branch, ${GITHUB_REF##*/}
run: poetry run mike deploy --push "${GITHUB_REF##*/}"
run: |
cd ${{ env.DOCS_REPO }}
poetry run mike deploy --push "${GITHUB_REF##*/}"

- name: Set default docs to ${LATEST_STABLE_BRANCH##*/}
run: poetry run mike set-default --push "${LATEST_STABLE_BRANCH##*/}"
run: |
cd ${{ env.DOCS_REPO }}
poetry run mike set-default --push "${LATEST_STABLE_BRANCH##*/}"