-
Notifications
You must be signed in to change notification settings - Fork 79
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This reverts commit 82bf0bc.
- Loading branch information
Showing
237 changed files
with
34,408 additions
and
16,307 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
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 |
---|---|---|
@@ -1,36 +1,23 @@ | ||
name: Build and Deploy | ||
on: | ||
workflow_dispatch: | ||
push: | ||
branches: | ||
- master | ||
|
||
permissions: | ||
contents: write | ||
|
||
jobs: | ||
build-and-deploy: | ||
runs-on: ubuntu-latest | ||
|
||
# Load environment variables from repository settings, | ||
# environment should be named "production" | ||
# https://github.com/cadence-workflow/Cadence-Docs/settings/environments | ||
environment: production | ||
env: | ||
CADENCE_DOCS_URL: ${{ vars.CADENCE_DOCS_URL || 'https://cadenceworkflow.io' }} | ||
CADENCE_DOCS_BASE_URL: ${{ vars.CADENCE_DOCS_BASE_URL || '/Cadence-Docs/' }} | ||
CADENCE_DOCS_ORGANIZATION: ${{ vars.CADENCE_DOCS_ORGANIZATION || 'cadence-workflow' }} | ||
|
||
steps: | ||
# same as build.yml | ||
- name: Checkout 🛎️ | ||
uses: actions/checkout@v4 | ||
uses: actions/checkout@v3 | ||
with: | ||
persist-credentials: false | ||
- name: Use Node.js lts/hydrogen (v18) | ||
uses: actions/setup-node@v4 | ||
- name: Use Node.js v18 | ||
uses: actions/setup-node@v3 | ||
with: | ||
node-version: lts/hydrogen | ||
node-version: 18.x | ||
# See supported Node.js release schedule at https://nodejs.org/en/about/releases/ | ||
cache: 'npm' | ||
- name: Install and Build 🔧 | ||
|
@@ -42,11 +29,12 @@ jobs: | |
- name: Configure domain | ||
uses: finnp/[email protected] | ||
env: | ||
FILE_NAME: "build/CNAME" | ||
FILE_NAME: "dist/CNAME" | ||
FILE_DATA: ${{ secrets.CUSTOM_DOMAIN }} | ||
- name: Deploy 🚀 | ||
uses: JamesIves/github-pages-deploy-action@v4 | ||
uses: JamesIves/github-pages-deploy-action@3.7.1 | ||
with: | ||
branch: gh-pages # The branch the action should deploy to. | ||
folder: build # The folder the action should deploy. | ||
clean: true # Automatically remove deleted files from the deploy branch | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
BRANCH: gh-pages # The branch the action should deploy to. | ||
FOLDER: dist # The folder the action should deploy. | ||
CLEAN: true # Automatically remove deleted files from the deploy branch |
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 |
---|---|---|
@@ -1,40 +1,13 @@ | ||
### macOS ### | ||
# General | ||
.DS_Store | ||
.AppleDouble | ||
.LSOverride | ||
|
||
# cypress | ||
cypress/fixtures | ||
cypress/plugins | ||
cypress/support | ||
cypress/videos | ||
|
||
# dependencies | ||
/node_modules | ||
|
||
dist | ||
dist-blog | ||
node_modules | ||
npm-debug.log | ||
# package-lock file is required for cypress github action to work. | ||
# See https://github.com/marketplace/actions/cypress-io#installation for more information. | ||
# package-lock.json | ||
yarn-error.log | ||
|
||
### VisualStudioCode ### | ||
.vscode/* | ||
|
||
# Production | ||
/build | ||
|
||
# Generated files | ||
.docusaurus | ||
.cache-loader | ||
|
||
# Misc | ||
.envrc.local | ||
.env.local | ||
.env.development.local | ||
.env.test.local | ||
.env.production.local | ||
|
||
npm-debug.log* | ||
yarn-debug.log* | ||
yarn-error.log* |
Empty file.
Empty file.
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 |
---|---|---|
@@ -1,72 +1,19 @@ | ||
# [Cadence docs](https://cadenceworkflow.io) · ![Build and Deploy](https://img.shields.io/github/actions/workflow/status/cadence-workflow/Cadence-Docs/publish-to-gh-pages.yml?label=Build%20and%20Deploy&link=https%3A%2F%2Fgithub.jparrowsec.cn%2Fcadence-workflow%2FCadence-Docs%2Factions%2Fworkflows%2Fpublish-to-gh-pages.yml) ![Nightly integration test](https://img.shields.io/github/actions/workflow/status/cadence-workflow/Cadence-Docs/nightly-integration-test.yml?label=Nightly%20integration%20test&link=https%3A%2F%2Fgithub.jparrowsec.cn%2Fcadence-workflow%2FCadence-Docs%2Factions%2Fworkflows%2Fnightly-integration-test.yml) | ||
# [Cadence docs](https://cadenceworkflow.io) · ![Build and Deploy](https://img.shields.io/github/actions/workflow/status/uber/Cadence-Docs/publish-to-gh-pages.yml?label=Build%20and%20Deploy&link=https%3A%2F%2Fgithub.jparrowsec.cn%2Fuber%2FCadence-Docs%2Factions%2Fworkflows%2Fpublish-to-gh-pages.yml) ![Nightly integration test](https://img.shields.io/github/actions/workflow/status/uber/Cadence-Docs/nightly-integration-test.yml?label=Nightly%20integration%20test&link=https%3A%2F%2Fgithub.jparrowsec.cn%2Fuber%2FCadence-Docs%2Factions%2Fworkflows%2Fnightly-integration-test.yml) | ||
|
||
## Setting up for local development | ||
This will start a local server and can be accessed at http://localhost:8080/ | ||
1. Run `npm install` | ||
2. Run `npm run start` | ||
|
||
### Adding pages to docs | ||
1. Add the page under `Cadence-Docs/src/docs` in the correct place in the hierarchy | ||
2. Add the page to `Cadence-Docs/src/.vuepress/config.js` | ||
|
||
# cadenceworkflow.io | ||
|
||
[Cadence docs](https://cadenceworkflow.io) is built using [Docusaurus](https://docusaurus.io/). | ||
|
||
|
||
|
||
### Installation | ||
|
||
```console | ||
$ npm install | ||
``` | ||
|
||
### Local Development | ||
|
||
```console | ||
$ npm run start | ||
``` | ||
|
||
This command starts a local development server and opens up a browser window at http://localhost:3000/. Most changes are reflected live without having to restart the server. | ||
|
||
### Build | ||
|
||
```console | ||
$ npm run build | ||
``` | ||
|
||
This command generates static content into the `build` directory and can be served using any static contents hosting service. | ||
|
||
### Environment Variables | ||
|
||
In order to deploy to multiple environments, some configuration options in `docusaurus.config.ts` are made available for override through environment variables. | ||
|
||
```bash | ||
# Can be replaced by your GH pages url, ie. https://<userId>.github.io/ | ||
CADENCE_DOCS_URL=https://cadenceworkflow.io | ||
|
||
# For GitHub pages deployment, it is often /<projectName>/ defaults to `/` | ||
CADENCE_DOCS_BASE_URL=/cadence-docs/ | ||
|
||
# For Github pages only, this is your Github org/user name. | ||
CADENCE_DOCS_ORGANIZATION=cadence-workflow | ||
``` | ||
|
||
### Deployment | ||
|
||
Using SSH: | ||
|
||
```console | ||
$ USE_SSH=true npm run deploy | ||
``` | ||
|
||
Not using SSH: | ||
|
||
```console | ||
$ GIT_USER=<Your GitHub username> npm run deploy | ||
``` | ||
|
||
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. | ||
|
||
|
||
# NPM Registry | ||
|
||
Ensure you have a `.npmrc` [file](https://docs.npmjs.com/cli/v9/configuring-npm/npmrc/) configured with `registry=https://registry.npmjs.org/`. | ||
This will ensure the dependencies are pulled from the correct source and to prevent internal npm registries from being pushed onto the package-lock.json | ||
## Setting up for local development for blog pages | ||
This will start a local server and can be accessed at http://localhost:8080/blog | ||
1. Run `npm install` | ||
2. Run `npm run start:blog` | ||
|
||
## License | ||
|
||
MIT License, please see [LICENSE](https://github.com/cadence-workflow/Cadence-Docs/blob/master/LICENSE) for details. | ||
MIT License, please see [LICENSE](https://github.com/uber/Cadence-Docs/blob/master/LICENSE) for details. |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.