Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add workflow for tsdoc #5964

Merged
merged 2 commits into from
Jul 20, 2023
Merged

Add workflow for tsdoc #5964

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f8df78c
Add workflow for tsdoc
takameyer Jul 6, 2023
6b918f4
Refactor workflow to determine package being published and where to p…
takameyer Jul 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 0 additions & 48 deletions .github/workflows/docs-publish-realm-react.yml
View file
Open in desktop

This file was deleted.

34 changes: 21 additions & 13 deletions .github/workflows/publish-realm-docs.yml → .github/workflows/publish-docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# This workflow builds the TypeDoc for relevant and publishes it to https://docs.mongodb.com/realm-sdks/js/
# This workflow builds the TypeDoc documentation and publishes it to https://docs.mongodb.com/realm-sdks/
# It will determine if it's a pre-release or an official release
# and publish to the appropriate location based on package name and version.
# pre-releases are published to /next
# releases are published to /latest
# releases are published to /latest and the base URL
# all releases are published to /<version>

name: Publish Realm Docs
name: Publish Docs
on:
push:
tags:
Expand All @@ -26,7 +27,7 @@ jobs:
- uses: realm/ci-actions/parse-release-tag@andrew/parse-tag
id: parse-release-tag
with:
release-tag: ${{ github.event.inputs.tag || github.event.ref }}
release-tag: ${{ github.event.inputs.tag || github.ref_name }}
- uses: actions/checkout@v3
with:
submodules: "recursive"
Expand All @@ -40,25 +41,32 @@ jobs:
- name: Install root package dependencies
run: npm ci --ignore-scripts
- name: Build docs
working-directory: packages/${{ steps.parse-release-tag.outputs.package-name || "realm" }}}
working-directory: packages/${{ steps.parse-release-tag.outputs.package-name }}
run: npm run docs
- name: Set up S3cmd and configure AWS credentials
- name: Set up S3 cmd and configure AWS credentials
uses: s3-actions/[email protected]
with:
provider: aws
region: "us-west-1"
access_key: ${{ secrets.DOCS_S3_ACCESS_KEY }}
secret_key: ${{ secrets.DOCS_S3_SECRET_KEY }}
- name: Set up S3 base URL for packages
run: echo "S3_BASE_URL=s3://${{ secrets.DOCS_S3_BUCKET_NAME }}/docs/realm-sdks/js/${{steps.parse-release-tag.outputs.package-name}}" >> $GITHUB_ENV
- name: Set up S3 base URL for realm
if: steps.parse-release-tag.outputs.package-name == 'realm'
run: echo "S3_BASE_URL=s3://${{ secrets.DOCS_S3_BUCKET_NAME }}/docs/realm-sdks/js" >> $GITHUB_ENV
# --no-mime-magic --guess-mime-type flags to work around CSS incorrect MIME type issue
# (https://stackoverflow.com/questions/53708938/s3cmd-flagging-css-with-wrong-mime-type)
- name: Upload versioned docs (for archival)
working-directory: packages/${{ steps.parse-release-tag.outputs.package-name || "realm" }}}
run: s3cmd put --recursive --acl-public --no-mime-magic --guess-mime-type docs/ s3://${{ secrets.DOCS_S3_BUCKET_NAME }}/docs/realm-sdks/js/${{ steps.parse-release-tag.outputs.package-name || "realm" }}/${{ steps.parse-release-tag.outputs.package-version}}/
- name: Upload prerelase docs
working-directory: packages/${{ steps.parse-release-tag.outputs.package-name }}
run: s3cmd put --recursive --acl-public --no-mime-magic --guess-mime-type docs/ ${{ env.S3_BASE_URL }}/${{ steps.parse-release-tag.outputs.package-version }}/
- name: Upload prerelease docs
if: steps.parse-release-tag.outputs.prerelease == 'true'
working-directory: packages/${{ steps.parse-release-tag.outputs.package-name || "realm" }}}
run: s3cmd put --recursive --acl-public --no-mime-magic --guess-mime-type docs/ s3://${{ secrets.DOCS_S3_BUCKET_NAME }}/docs/realm-sdks/js/${{ steps.parse-release-tag.outputs.package-name || "realm" }}/next/
working-directory: packages/${{ steps.parse-release-tag.outputs.package-name }}
run: s3cmd put --recursive --acl-public --no-mime-magic --guess-mime-type docs/ ${{ env.S3_BASE_URL }}/next/
- name: Upload latest docs (to live site)
if: steps.parse-release-tag.outputs.prerelease == 'false'
working-directory: packages/${{ steps.parse-release-tag.outputs.package-name || "realm" }}}
run: s3cmd put --recursive --acl-public --no-mime-magic --guess-mime-type docs/ s3://${{ secrets.DOCS_S3_BUCKET_NAME }}/docs/realm-sdks/js/${{ steps.parse-release-tag.outputs.package-name }}/latest/
working-directory: packages/${{ steps.parse-release-tag.outputs.package-name }}
run: |
s3cmd put --recursive --acl-public --no-mime-magic --guess-mime-type docs/ ${{ env.S3_BASE_URL }}/latest/
s3cmd put --recursive --acl-public --no-mime-magic --guess-mime-type docs/ ${{ env.S3_BASE_URL }}/
Loading