Skip to content

Commit

Permalink
Fix doc build and remove old docs (#586)
Browse files Browse the repository at this point in the history
* Feat/pages (#1)

* remove old pages, add new github action, docs

* only run on main branch

* update changelog

* fix tests
  • Loading branch information
samsipe authored Dec 1, 2023
1 parent ca05ad7 commit 64a473d
Show file tree
Hide file tree
Showing 8 changed files with 913 additions and 8,244 deletions.
52 changes: 52 additions & 0 deletions .github/workflows/pages.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
name: Deploy STAC API Docs with GitHub Pages

on:
push:
branches:
- main

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Setup Pages
uses: actions/configure-pages@v3
- uses: actions/setup-node@v3
with:
node-version-file: ".nvmrc"
cache: npm
cache-dependency-path: package.json
- name: Upgrade npm
run: npm install -g npm@latest
- name: Install dependencies
run: npm install
- name: Build docs
run: npm run build-api-docs
- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
path: ./docs
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,4 @@ _book
serverless*.yml
!serverless.example.yml
tsconfig.tsbuildinfo
docs/
15 changes: 15 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,21 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

## Unreleased - TBD

### Added

- redocly devDependency for docs build

### Removed

- Unused devDependencies for old docs build
- Old `./docs` directory and out of date docs

### Fixed

- STAC API Docs now build and deploy to GitHub Pages using redocly

## [3.2.0] - 2023-11-29

### Added
Expand Down
Loading

0 comments on commit 64a473d

Please sign in to comment.