Skip to content

Commit

Permalink
Merge pull request #28 from oddbird/auto-docs
Browse files Browse the repository at this point in the history
Automatically publish oddleventy docs
  • Loading branch information
jgerigmeyer authored Nov 7, 2022
2 parents 4561461 + f8999bc commit c151211
Show file tree
Hide file tree
Showing 24 changed files with 62 additions and 8,522 deletions.
54 changes: 54 additions & 0 deletions .github/workflows/publish-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
name: Publish documentation
on:
release: # Run when stable releases are published
types: [released]
workflow_dispatch: # Run on-demand
inputs:
ref:
description: Git ref to build docs from
required: true
default: main
type: string

jobs:
push-branch:
name: Build & push docs
runs-on: ubuntu-latest
permissions:
contents: write
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
steps:
- name: Check out from release
if: github.event_name == 'release'
uses: actions/checkout@v3
- name: Check out from manual input
if: github.event_name == 'workflow_dispatch'
uses: actions/checkout@v3
with:
ref: ${{ inputs.ref }}
- uses: actions/setup-node@v3
with:
node-version: 'lts/*'
cache: yarn
- run: yarn install
- run: yarn build-docs
- name: Clone docs branch
uses: actions/checkout@v3
with:
path: docs-branch
ref: oddleventy-docs
- name: Commit & push to docs branch
run: |
SHA=$(git rev-parse HEAD)
cd docs-branch
rm -rf cascading-colors/docs
mkdir -p cascading-colors/docs
cp -r ${{ github.workspace }}/docs/ cascading-colors/
git config user.name github-actions
git config user.email github-actions@github.com
git add -A .
git commit --allow-empty \
-m "Update from https://github.com/${{ github.repository }}/commit/$SHA" \
-m "Full log: https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}"
git push origin oddleventy-docs
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
demo/js/
demo/css/

# Docs
docs/

# Logs
logs
*.log
Expand Down
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Changelog

## UNRELEASED

- 🏠 INTERNAL: Remove documentation from npm package

## 0.1.0-beta.15 - 2020/10/20

- INTERNAL: Update dependencies & fix demo site
Expand Down
Loading

0 comments on commit c151211

Please sign in to comment.