Skip to content

Commit

Permalink
Release v0.9.1-rc1 (#684)
Browse files Browse the repository at this point in the history
* bump to v0.9.1

* update changelog

* use specific GHA workflow to deploy docs

* set version to 0.9.1-rc1 to test docs deployment
  • Loading branch information
vtnate authored Dec 18, 2024
1 parent d52c659 commit 3cade17
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 26 deletions.
31 changes: 7 additions & 24 deletions .github/workflows/documentation_site.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,33 +5,16 @@ on:
- main
paths:
- docs/**
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

permissions:
contents: write

jobs:
deploy:
runs-on: ubuntu-latest
environment:
name: github-pages

steps:
- uses: actions/checkout@v4
- name: Configure Git Credentials
run: |
git config user.name github-actions[bot]
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
- uses: actions/setup-python@v5
with:
python-version: 3.13
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
- uses: actions/cache@v4
with:
key: mkdocs-material-${{ env.cache_id }}
path: .cache
restore-keys: |
mkdocs-material-
- run: pip install mkdocs-material mkdocs-schema-reader mkdocstrings-python markdown-include
- run: mkdocs gh-deploy --force
- name: Deploy docs
uses: mhausenblas/mkdocs-deploy-gh-pages@master
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
CUSTOM_DOMAIN: https://docs.urbanopt.net/geojson-modelica-translator/
CONFIG_FILE: mkdocs.yml
REQUIREMENTS: docs/docs_requirements.txt
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Change Log

## Version 0.9.1

* Fix incorrect link to documentation site by @vtnate

## Version 0.9.0

### Exciting New Features 🎉
Expand Down
4 changes: 4 additions & 0 deletions docs/docs_requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
markdown-include~=0.8.1
mkdocs-material~=9.5.49
mkdocs-schema-reader~=0.11.1
mkdocstrings-python~=1.12.2"
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "geojson-modelica-translator"
version = "0.9.0"
version = "0.9.1-rc1"
description = "Package for converting GeoJSON to Modelica models for urban scale analyses."
authors = ["URBANopt DES Team <[email protected]>"]
license = "BSD-4-Clause"
Expand Down Expand Up @@ -55,7 +55,7 @@ pytest = "~7.4"
pytest-cov = "~4.1"
syrupy = "~4.6"
toml = "~0.10"
# documentation
# documentation - these are used during development of docs, not deployment
markdown-include = "~0.8.1"
mkdocs-material = "~9.5"
mkdocs-schema-reader = "~0.11.1"
Expand Down

0 comments on commit 3cade17

Please sign in to comment.