-
-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: remove references to old documentation
- Loading branch information
Showing
5 changed files
with
3 additions
and
88 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -57,57 +57,3 @@ jobs: | |
npm publish --tag ${TAG} || true | ||
env: | ||
NODE_AUTH_TOKEN: ${{ secrets.NPM_PUBLISH_TOKEN }} | ||
|
||
Docgen: | ||
name: Docgen | ||
runs-on: ubuntu-latest | ||
if: "github.event_name == 'push'" | ||
steps: | ||
- name: Checkout Project | ||
uses: actions/checkout@1e204e9a9253d643386038d443f96446fa156a97 # renovate: tag=v2 | ||
- name: Use Node.js v16 | ||
uses: actions/setup-node@270253e841af726300e85d718a5f606959b2903c # renovate: tag=v2 | ||
with: | ||
node-version: 16 | ||
- name: Restore CI Cache | ||
uses: actions/cache@c64c572235d810460d0d6876e9c705ad5002b353 # renovate: tag=v2.1.6 | ||
id: cache-restore | ||
with: | ||
path: node_modules | ||
key: ${{ runner.os }}-16-${{ hashFiles('**/yarn.lock') }} | ||
- name: Install Dependencies if Cache Miss | ||
if: ${{ !steps.cache-restore.outputs.cache-hit }} | ||
run: yarn --immutable | ||
- name: Build documentation | ||
run: yarn docs | ||
- name: Publish Docs | ||
if: github.event_name == 'push' && github.ref == 'refs/heads/main' | ||
run: | | ||
REPO="https://${GITHUB_ACTOR}:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git" | ||
echo -e "\n# Checkout the repo in the target branch" | ||
TARGET_BRANCH="gh-pages" | ||
git clone $REPO out -b $TARGET_BRANCH | ||
echo -e "\n# Remove any old files in the out folder" | ||
rm -rfv out/assets/* | ||
rm -rfv out/interfaces/* | ||
rm -rfv out/*.html | ||
echo -e "\n# Move the generated docs to the newly-checked-out repo, to be committed and pushed" | ||
rsync -vaI .all-contributorsrc out/ | ||
rsync -vaI LICENSE.md out/ | ||
rsync -vaI README.md out/ | ||
rsync -vaI docs/ out/ | ||
echo -e "\n# Commit and push" | ||
cd out | ||
git add --all . | ||
git config user.name "${GITHUB_ACTOR}" | ||
git config user.email "${GITHUB_EMAIL}" | ||
git commit -m "docs: api docs build for ${GITHUB_SHA}" || true | ||
git push origin $TARGET_BRANCH | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.SKYRA_TOKEN }} | ||
GITHUB_ACTOR: NM-EEA-Y | ||
GITHUB_EMAIL: [email protected] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters