Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: sapphiredev/framework
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: v3.1.0
Choose a base ref
...
head repository: sapphiredev/framework
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: v3.1.1
Choose a head ref
  • 7 commits
  • 13 files changed
  • 3 contributors

Commits on Aug 30, 2022

  1. chore(docs): add typedoc-json-parser (#520)

    * chore(docs): add `typedoc-json-parser`
    
    * chore(pr): requested changes
    RealShadowNova authored Aug 30, 2022
    Copy the full SHA
    3d06db1 View commit details

Commits on Aug 31, 2022

  1. Copy the full SHA
    0dc0b89 View commit details

Commits on Sep 1, 2022

  1. Copy the full SHA
    645df81 View commit details

Commits on Sep 3, 2022

  1. fix: only fetch guild ids for commands that require them (#523)

    * fix: only fetch guild ids for commands that require them
    
    * fix: check for null guilds
    
    * chore: requested change
    vladfrangu authored Sep 3, 2022
    Copy the full SHA
    61f2c07 View commit details
  2. fix: bump sapphire utilities

    favna committed Sep 3, 2022
    Copy the full SHA
    7015275 View commit details
  3. chore: bump dev deps

    favna committed Sep 3, 2022
    Copy the full SHA
    4697a71 View commit details
  4. chore(release): release 3.1.1

    favna committed Sep 3, 2022
    Copy the full SHA
    e5d15e6 View commit details
102 changes: 102 additions & 0 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
name: Documentation

on:
push:
branches:
- main
tags:
- 'v*'

concurrency:
group: ${{ github.workflow }}-${{ github.head_ref || github.ref }}
cancel-in-progress: true

jobs:
build:
name: Build Documentation
runs-on: ubuntu-latest

if: github.repository_owner == 'sapphiredev'
outputs:
NAME: ${{ steps.env.outputs.NAME }}
TYPE: ${{ steps.env.outputs.TYPE }}
SHA: ${{ steps.env.outputs.SHA }}
steps:
- name: Checkout Project
uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b # tag=v3
- name: Use Node.js v16
uses: actions/setup-node@eeb10cff27034e7acf239c5d29f62154018672fd # tag=v3
with:
node-version: 16
cache: yarn
registry-url: https://registry.npmjs.org/
- name: Install Dependencies
run: yarn --immutable
- name: Build Documentation
run: yarn docs
- name: Upload Documentation Artifacts
uses: actions/upload-artifact@3cea5372237819ed00197afe530f5a7ea3e805c8 # tag=v3
with:
name: docs
path: docs/api.json
- name: Set Output
id: env
run: |
echo "::set-output name=NAME::${GITHUB_REF_NAME}"
echo "::set-output name=TYPE::${GITHUB_REF_TYPE}"
echo "::set-output name=SHA::${GITHUB_SHA}"
upload:
name: Upload Documentation
needs: build
runs-on: ubuntu-latest
env:
NAME: ${{ needs.build.outputs.NAME }}
TYPE: ${{ needs.build.outputs.TYPE }}
SHA: ${{ needs.build.outputs.SHA }}
steps:
- name: Checkout Project
uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b # tag=v3
- name: Use Node.js v16
uses: actions/setup-node@eeb10cff27034e7acf239c5d29f62154018672fd # tag=v3
with:
node-version: 16
cache: yarn
registry-url: https://registry.yarnpkg.org/
- name: Install Dependencies
run: yarn --immutable
- name: Download Documentation Artifacts
uses: actions/download-artifact@fb598a63ae348fa914e94cd0ff38f362e927b741 # tag=v3
with:
name: docs
path: docs
- name: Checkout Documentation Project
uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b # tag=v3
with:
repository: 'sapphiredev/docs'
token: ${{ secrets.SKYRA_TOKEN }}
path: 'out'

- name: Move Documentation
if: ${{ env.TYPE == 'tag' }}
env:
SEMVER: ${{ env.NAME }}
run: |
mkdir -p out/framework
mv docs/api.json out/docs/framework/${SEMVER}.json
- name: Move Documentation
if: ${{ env.TYPE == 'branch' }}
run: |
mkdir -p out/framework
mv docs/api.json out/docs/framework/${NAME}.json
- name: Commit & Push
run: |
cd out
git config user.name github-actions[bot]
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
git config rebase.autostash true
git config pull.rebase true
git add .
git commit -m "docs(framework): build for ${TYPE} ${NAME}: ${SHA}" || true
git pull
git push
1 change: 1 addition & 0 deletions .typedoc-json-parserrc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
json: 'docs/api.json'
Loading