Skip to content
This repository has been archived by the owner on Aug 2, 2024. It is now read-only.

Commit

Permalink
deploy docs for the latest release to 'latest'
Browse files Browse the repository at this point in the history
  • Loading branch information
balins committed Apr 25, 2024
1 parent 8367545 commit 874c804
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 1 deletion.
14 changes: 14 additions & 0 deletions .github/workflows/gh-pages.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ on:
tags: ['v**']

workflow_dispatch:
inputs:
set-latest:
type: boolean
required: true
default: false
description: Mark deployed docs as the latest stable release

permissions:
contents: write
Expand Down Expand Up @@ -38,3 +44,11 @@ jobs:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs
destination_dir: ${{ github.ref_name }}

- name: Deploy for the latest release
if: startsWith(github.ref, 'refs/tags/v') || inputs.set-latest
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs
destination_dir: latest
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ npm install @jellyfish-dev/js-server-sdk

## Documentation

The latest SDK documentation is available [here](https://jellyfish-dev.github.io/js-server-sdk/main).
The documentation for the latest release is available [here](https://jellyfish-dev.github.io/js-server-sdk/latest).
To generate it locally, run:

```bash
Expand Down

0 comments on commit 874c804

Please sign in to comment.