mirror of https://github.com/apache/superset.git
docs: add publish step (#14304)
This commit is contained in:
parent
2b57ebaffd
commit
e913ef3261
|
@ -0,0 +1 @@
|
|||
Subproject commit f30895310c20ef3d2569a5f690a80e56faf36c19
|
|
@ -9,14 +9,15 @@ on:
|
|||
- "docs/**"
|
||||
|
||||
jobs:
|
||||
docs:
|
||||
name: docs
|
||||
build-deploy:
|
||||
name: Build & Deploy
|
||||
runs-on: ubuntu-20.04
|
||||
steps:
|
||||
- name: "Checkout ${{ github.ref }} ( ${{ github.sha }} )"
|
||||
uses: actions/checkout@v2
|
||||
with:
|
||||
persist-credentials: false
|
||||
submodules: recursive
|
||||
- name: npm install
|
||||
working-directory: ./docs
|
||||
run: |
|
||||
|
@ -29,3 +30,15 @@ jobs:
|
|||
working-directory: ./docs
|
||||
run: |
|
||||
npm run build
|
||||
- name: deploy docs
|
||||
if: github.ref == 'refs/heads/master'
|
||||
uses: ./.github/actions/github-action-push-to-another-repository
|
||||
env:
|
||||
API_TOKEN_GITHUB: ${{ secrets.SUPERSET_SITE_BUILD }}
|
||||
with:
|
||||
source-directory: './docs/public'
|
||||
destination-github-username: 'apache'
|
||||
destination-repository-name: 'superset-site'
|
||||
target-branch: 'asf-site'
|
||||
commit-message: "deploying docs: ${{ github.event.head_commit.message }} (apache/superset@${{ github.sha }})"
|
||||
user-email: dev@superset.apache.org
|
||||
|
|
|
@ -36,3 +36,6 @@
|
|||
[submodule ".github/actions/chart-releaser-action"]
|
||||
path = .github/actions/chart-releaser-action
|
||||
url = https://github.com/helm/chart-releaser-action
|
||||
[submodule ".github/actions/github-action-push-to-another-repository"]
|
||||
path = .github/actions/github-action-push-to-another-repository
|
||||
url = git@github.com:cpina/github-action-push-to-another-repository.git
|
||||
|
|
|
@ -23,7 +23,6 @@ Here's the source to the documentation hosted at
|
|||
The site runs on the Gatsby framework and uses docz for it's
|
||||
`Documentation` subsection.
|
||||
|
||||
|
||||
## Getting Started
|
||||
|
||||
```bash
|
||||
|
@ -35,7 +34,10 @@ npm run start
|
|||
|
||||
## To Publish
|
||||
|
||||
To publish, the static site that Gatsby generates needs to be pushed
|
||||
Github Actions CI automatically publishes the site after changes are
|
||||
merged to master.
|
||||
|
||||
To manually publish, the static site that Gatsby generates needs to be pushed
|
||||
to the `asf-site` branch on the
|
||||
[apache/superset-site](https://github.com/apache/superset-site/)
|
||||
repository. No need to PR here, simply `git push`.
|
||||
|
|
Loading…
Reference in New Issue