docs: add GitHub Pages documentation deployment workflow

- Create GitHub Actions workflow for deploying documentation to GitHub Pages
- Update README.md with documentation badge and link
- Add missing gem dependency in docs/Gemfile
- Configure Jekyll build and deployment process
This commit is contained in:
jango-blockchained
2025-02-04 17:37:20 +01:00
parent c11b40da9e
commit 5f4ddfbd88
3 changed files with 71 additions and 2 deletions

64
.github/workflows/deploy-docs.yml vendored Normal file
View File

@@ -0,0 +1,64 @@
name: Deploy Documentation to GitHub Pages
on:
push:
branches:
- main
paths:
- 'docs/**'
- '.github/workflows/deploy-docs.yml'
permissions:
contents: read
pages: write
id-token: write
# Allow only one concurrent deployment
concurrency:
group: "pages"
cancel-in-progress: true
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Ruby
uses: ruby/setup-ruby@v1
with:
ruby-version: '3.2'
bundler-cache: true
cache-version: 0
- name: Setup Pages
uses: actions/configure-pages@v4
- name: Install dependencies
run: |
cd docs
bundle install
- name: Build site
run: |
cd docs
bundle exec jekyll build
env:
JEKYLL_ENV: production
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: docs/_site
deploy:
needs: build
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4

View File

@@ -6,6 +6,7 @@ The Model Context Protocol (MCP) Server is a robust, secure, and high-performanc
![Bun](https://img.shields.io/badge/bun-%3E%3D1.0.26-black) ![Bun](https://img.shields.io/badge/bun-%3E%3D1.0.26-black)
![TypeScript](https://img.shields.io/badge/typescript-%5E5.0.0-blue.svg) ![TypeScript](https://img.shields.io/badge/typescript-%5E5.0.0-blue.svg)
![Test Coverage](https://img.shields.io/badge/coverage-95%25-brightgreen.svg) ![Test Coverage](https://img.shields.io/badge/coverage-95%25-brightgreen.svg)
[![Documentation](https://img.shields.io/badge/docs-github.io-blue.svg)](https://jango-blockchained.github.io/homeassistant-mcp/)
## Table of Contents ## Table of Contents
@@ -221,7 +222,7 @@ This project is licensed under the MIT License. See [LICENSE](LICENSE) for the f
## Documentation ## Documentation
Full documentation is available at: https://yourusername.github.io/your-repo-name/ Full documentation is available at: [https://jango-blockchained.github.io/homeassistant-mcp/](https://jango-blockchained.github.io/homeassistant-mcp/)
## Quick Start ## Quick Start

View File

@@ -11,3 +11,7 @@ platforms :mingw, :x64_mingw, :mswin, :jruby do
gem "tzinfo", ">= 1" gem "tzinfo", ">= 1"
gem "tzinfo-data" gem "tzinfo-data"
end end
# Lock `http_parser.rb` gem to `v0.6.x` on JRuby builds since newer versions of the gem
# do not have a Java counterpart.
gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby]