diff --git a/website/docs/deployment.mdx b/website/docs/deployment.mdx index e4fecee79270..bb4cb9cdef76 100644 --- a/website/docs/deployment.mdx +++ b/website/docs/deployment.mdx @@ -23,27 +23,30 @@ You can deploy your site to static site hosting services such as [Vercel](https: A Docusaurus site is statically rendered, and it can generally work without JavaScript! -## Testing your Build Locally {#testing-build-locally} +## Configuration {#configuration} + +The following parameters are required in `docusaurus.config.js` in order for Docusaurus to optimize routing and serve files from the correct location: + +| Name | Description | +| --- | --- | +| `url` | URL for your site. For a site deployed at `https://my-org.com/my-project/`, `url` is `https://my-org.com/`. | +| `baseUrl` | Base URL for your project, with a trailing slash. For a site deployed at `https://my-org.com/my-project/`, `baseUrl` is `/my-project/`. | -It is important to test your build locally before deploying to production. +## Testing your Build Locally {#testing-build-locally} -Docusaurus includes a [`docusaurus serve`](cli.md#docusaurus-serve-sitedir) command for that: +It is important to test your build locally before deploying to production. Docusaurus provides a [`docusaurus serve`](cli.md#docusaurus-serve-sitedir) command for that: ```bash npm2yarn npm run serve ``` -By default this will load your site at [http://localhost:3000/](http://localhost:3000/). +By default, this will load your site at [http://localhost:3000/](http://localhost:3000/). ## Trailing slash configuration {#trailing-slashes} Docusaurus has a [`trailingSlash` config](./api/docusaurus.config.js.md#trailing-slash), to allow customizing URLs/links and emitted filename patterns. -The default value generally works fine. - -Unfortunately, each static hosting provider has a **different behavior**, and deploying the exact same site to various hosts can lead to distinct results. - -Depending on your host, it can be useful to change this config. +The default value generally works fine. Unfortunately, each static hosting provider has a **different behavior**, and deploying the exact same site to various hosts can lead to distinct results. Depending on your host, it can be useful to change this config. :::tip @@ -65,32 +68,48 @@ It is not the best option, compared to a static hosting provider / CDN. ::: +:::warning + +In the following sections, we will introduce a few common hosting providers and how they should be configured to deploy Docusaurus sites most efficiently. The documentation may not be up-to-date: recent changes in their API may not be reflected on our side. If you see outdated content, PRs are welcome. + +For the same concern of up-to-datedness, we have stopped accepting PRs adding new hosting options. You can, however, publish your writeup on a separate site (e.g. your blog, or the provider's official website), and ask us to include a link to your writeup. + +::: + ## Deploying to GitHub Pages {#deploying-to-github-pages} -Docusaurus provides an easy way to publish to [GitHub Pages](https://pages.github.com/). Which is hosting that comes for free with every GitHub repository. +Docusaurus provides an easy way to publish to [GitHub Pages](https://pages.github.com/), which comes for free with every GitHub repository. -### `docusaurus.config.js` settings {#docusaurusconfigjs-settings} +### Overview {#github-pages-overview} -First, modify your `docusaurus.config.js` and add the required params: +Usually, there are two repositories (at least, two branches) involved in a publishing process: the branch containing the source files, and the branch containing the build output to be served with GitHub Pages. In the following tutorial they will be referred to as **"source"** and **"target"**, respectively. -| Name | Description | -| --- | --- | -| `organizationName` | The GitHub user or organization that owns the repository. If you are the owner, it is your GitHub username. In the case of Docusaurus, it is "_facebook_" which is the GitHub organization that owns Docusaurus. | -| `projectName` | The name of the GitHub repository. For example, the repository name for Docusaurus is "docusaurus", so the project name is "docusaurus". | -| `deploymentBranch` | The name of the branch to deploy the static files to. This defaults to "gh-pages" for non-organization GitHub Pages repos. If the repo name ends in ".github.io", you have to either specify this property or set the environment variable `DEPLOYMENT_BRANCH`. | -| `url` | URL for your GitHub Page's user/organization page. This is commonly https://_username_.github.io. | -| `baseUrl` | Base URL for your project. For projects hosted on GitHub pages, it follows the format "/_projectName_/". For https://github.com/facebook/docusaurus, `baseUrl` is `/docusaurus/`. | +Each GitHub repository is associated with a GitHub Pages service. If the target repository is called `my-org/my-project` (where `my-org` is the organization name or username), the deployed site will appear at `https://my-org.github.io/my-project/`. Specially, if the target repository is called `my-org/my-org.github.io` (the _organization GitHub Pages repo_), the site will appear at `https://my-org.github.io/`. :::info -In case you want to use your custom domain for GitHub Pages, create a `CNAME` file in the `static` directory. Anything within the `static` directory will be copied to the root of the `build` directory for deployment. - -When using a custom domain, you should be able to move back from `baseUrl: '/projectName/'` to `baseUrl: '/'` +In case you want to use your custom domain for GitHub Pages, create a `CNAME` file in the `static` directory. Anything within the `static` directory will be copied to the root of the `build` directory for deployment. When using a custom domain, you should be able to move back from `baseUrl: '/projectName/'` to `baseUrl: '/'`. You may refer to GitHub Pages' documentation [User, Organization, and Project Pages](https://help.github.com/en/articles/user-organization-and-project-pages) for more details. ::: +GitHub Pages picks up deploy-ready files (the output from `docusaurus build`) from the default branch (`master` / `main`, usually) or the `gh-pages` branch, and either from the root or the `/docs` folder. You can configure that through `Settings > Pages` in your repository. This branch will be called the "target branch". + +We provide a `docusaurus deploy` command that helps you deploy your site from the source branch to the target branch in one command: clone, build, and commit. + +### `docusaurus.config.js` settings {#docusaurusconfigjs-settings} + +First, modify your `docusaurus.config.js` and add the following params: + +| Name | Description | +| --- | --- | +| `organizationName` | The GitHub user or organization that owns the target repository. | +| `projectName` | The name of the target repository. | +| `deploymentBranch` | The name of target branch. Defaults to `'gh-pages'` for non-organization GitHub Pages repos (`projectName` not ending in `.github.io`). Otherwise, this needs to be explicit as a config field or environment variable. | + +These fields also have their environment variable counterparts, which have a higher priority: `ORGANIZATION_NAME`, `PROJECT_NAME`, and `DEPLOYMENT_BRANCH`. + :::caution GitHub Pages adds a trailing slash to Docusaurus URLs by default. It is recommended to set a `trailingSlash` config (`true` or `false`, not `undefined`). @@ -123,16 +142,15 @@ Specify the Git user as an environment variable. | Name | Description | | --- | --- | -| `GIT_USER` | The username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your GitHub username. The specified `GIT_USER` must have push access to the repository specified in the combination of `organizationName` and `projectName`. | +| `GIT_USER` | The username for a GitHub account that **has push access to the target repo**. For your own repositories, this will usually be your GitHub username. | Optional parameters, also set as environment variables: | Name | Description | | --- | --- | | `USE_SSH` | Set to `true` to use SSH instead of the default HTTPS for the connection to the GitHub repo. | -| `DEPLOYMENT_BRANCH` | The branch that the website will be deployed to, defaults to `gh-pages`. For GitHub Pages Organization repos (`config.projectName` ending in `github.io`), you need to either set this env variable or specify the `deploymentBranch` param in `docusaurus.config.js`. | -| `CURRENT_BRANCH` | The branch that contains the latest docs changes that will be deployed. Usually, the branch will be `main`, but it could be any branch (default or otherwise) except for `gh-pages`. If nothing is set for this variable, then the current branch will be used. | -| `GIT_PASS` | Password (or token) of the `git` user (specified by `GIT_USER`). For example, to facilitate non-interactive deployment (e.g. continuous deployment) | +| `CURRENT_BRANCH` | The source branch. Usually, the branch will be `main` or `master`, but it could be any branch except for `gh-pages`. If nothing is set for this variable, then the current branch from which `docusaurus deploy` is invoked will be used. | +| `GIT_PASS` | Personal access token of the `git` user (specified by `GIT_USER`), to facilitate non-interactive deployment (e.g. continuous deployment) | GitHub enterprise installations should work in the same manner as github.com; you only need to set the organization's GitHub Enterprise host as an environment variable: @@ -183,95 +201,195 @@ Alternatively, you can use SSH (`USE_SSH=true`) to login. [GitHub Actions](https://help.github.com/en/actions) allow you to automate, customize, and execute your software development workflows right in your repository. -This workflow assumes your documentation resided in `documentation` branch of your repository and your [publishing source](https://help.github.com/en/github/working-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site) is configured for `gh-pages` branch. +The workflow examples below assume your website source resides in the `main` branch of your repository (the _source branch_ is `main`), under a folder called `website/`, and your [publishing source](https://help.github.com/en/github/working-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site) is configured for the `gh-pages` branch (the _target branch_ is `gh-pages`). + +Our goal is that: + +1. When a new pull request is made to `main` and updates `website/`, there's an action that ensures the site builds successfully, without actually deploying. This job will be called `test-deploy`. +2. When a pull request is merged to the `main` branch or someone pushes to the `main` branch directly and `website/` is updated, it will be built and deployed to the `gh-pages` branch. After that, the new built output will be served on the GitHub Pages site. This job will be called `deploy`. + +Here are two approaches to deploying your docs with GitHub Actions. Based on the location of your target branch (`gh-pages`), choose the relevant tab below: + +- Source repo and target repo are the **same** repository. +- The target repo is a **remote** repository, different from the source. + +````mdx-code-block + + + +While you can have both jobs defined in the same workflow file, the `deploy` job will always be listed as skipped in the PR check suite status. That's added noise providing no value to the review process, and as you cannot easily share common snippets, it is better to manage them as separate workflows instead. + +We will use a popular third-party deployment action: [peaceiris/actions-gh-pages](https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus). + +
+ +GitHub action files + +Add these two workflow files: + +:::warning + +These files assume you are using yarn. If you use npm, change `cache: yarn`, `yarn install --frozen-lockfile`, `yarn build` to `cache: npm`, `npm ci`, `npm run build` accordingly. + +::: + +```yml title=".github/workflows/deploy.yml" +name: Deploy to GitHub Pages + +on: + push: + branches: [main] + paths: [website/**] + +jobs: + deploy: + name: Deploy to GitHub Pages + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - uses: actions/setup-node@v2 + with: + node-version: 14.x + cache: yarn + - name: Build website + working-directory: website + run: | + yarn install --frozen-lockfile + yarn build + + # Popular action to deploy to GitHub Pages: + # Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus + - name: Deploy to GitHub Pages + uses: peaceiris/actions-gh-pages@v3 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + # Build output to publish to the `gh-pages` branch: + publish_dir: ./website/build + # Assign commit authorship to the official GH-Actions bot for deploys to `gh-pages` branch: + # https://github.com/actions/checkout/issues/13#issuecomment-724415212 + # The GH actions bot is used by default if you didn't specify the two fields. + # You can swap them out with your own user credentials. + user_name: github-actions[bot] + user_email: 41898282+github-actions[bot]@users.noreply.github.com +``` + +```yml title=".github/workflows/test-deploy.yml" +name: Test deployment + +on: + pull_request: + branches: [main] + paths: [website/**] + +jobs: + test-deploy: + name: Test deployment + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - uses: actions/setup-node@v2 + with: + node-version: 14.x + cache: yarn + - name: Test build + working-directory: website + run: | + yarn install --frozen-lockfile + yarn build +``` + +
+ + + + +A cross-repo publish is more difficult to set up, because you need to push to another repo with permission checks. We will be using SSH to do the authentication. 1. Generate a new [SSH key](https://help.github.com/en/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent). -1. By default, your public key should have been created in `~/.ssh/id_rsa.pub` or use the name you've provided in the previous step to add your key to [GitHub deploy keys](https://developer.github.com/v3/guides/managing-deploy-keys/). -1. Copy key to clipboard with `xclip -sel clip < ~/.ssh/id_rsa.pub` and paste it as a [deploy key](https://developer.github.com/v3/guides/managing-deploy-keys/#deploy-keys) in your repository. Copy file content if the command line doesn't work for you. Check the box for `Allow write access` before saving your deployment key. -1. You'll need your private key as a [GitHub secret](https://help.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets) to allow Docusaurus to run the deployment for you. -1. Copy your private key with `xclip -sel clip < ~/.ssh/id_rsa` and paste a GitHub secret with name `GH_PAGES_DEPLOY`. Copy file content if the command line doesn't work for you. Save your secret. -1. Create your [documentation workflow file](https://help.github.com/en/actions/configuring-and-managing-workflows/configuring-a-workflow#creating-a-workflow-file) in `.github/workflows/`. In this example it's `documentation.yml`. +2. By default, your public key should have been created in `~/.ssh/id_rsa.pub`; otherwise, use the name you've provided in the previous step to add your key to [GitHub deploy keys](https://developer.github.com/v3/guides/managing-deploy-keys/). +3. Copy the key to clipboard with `xclip -sel clip < ~/.ssh/id_rsa.pub` and paste it as a [deploy key](https://developer.github.com/v3/guides/managing-deploy-keys/#deploy-keys) in your repository. Copy the file content if the command line doesn't work for you. Check the box for `Allow write access` before saving your deployment key. +4. You'll need your private key as a [GitHub secret](https://help.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets) to allow Docusaurus to run the deployment for you. +5. Copy your private key with `xclip -sel clip < ~/.ssh/id_rsa` and paste a GitHub secret with the name `GH_PAGES_DEPLOY`. Copy the file content if the command line doesn't work for you. Save your secret. +6. Create your [documentation workflow file](https://help.github.com/en/actions/configuring-and-managing-workflows/configuring-a-workflow#creating-a-workflow-file) in `.github/workflows/`. In this example it's `deploy.yml`. + +
+ +GitHub action file :::warning Please make sure that you replace `actions@github.com` with your GitHub email and `gh-actions` with your name. +This file assumes you are using yarn. If you use npm, change `cache: yarn`, `yarn install --frozen-lockfile`, `yarn build` to `cache: npm`, `npm ci`, `npm run build` accordingly. + ::: -```yaml title="documentation.yml" -name: documentation +```yml title=".github/workflows/deploy.yml" +name: Deploy to GitHub Pages on: pull_request: - branches: [documentation] + branches: [main] push: - branches: [documentation] + branches: [main] jobs: - checks: + test-deploy: if: github.event_name != 'push' runs-on: ubuntu-latest steps: - - uses: actions/checkout@v1 - - uses: actions/setup-node@v1 + - uses: actions/checkout@v2 + - uses: actions/setup-node@v2 with: - node-version: '14.x' - - name: Test Build + node-version: 14.x + cache: yarn + - name: Test deployment run: | - if [ -e yarn.lock ]; then - yarn install --frozen-lockfile - elif [ -e package-lock.json ]; then - npm ci - else - npm i - fi - npm run build - gh-release: + yarn install --frozen-lockfile + yarn build + deploy: if: github.event_name != 'pull_request' runs-on: ubuntu-latest steps: - - uses: actions/checkout@v1 - - uses: actions/setup-node@v1 + - uses: actions/checkout@v2 + - uses: actions/setup-node@v2 with: - node-version: '14.x' + node-version: 14.x + cache: yarn - uses: webfactory/ssh-agent@v0.5.0 with: ssh-private-key: ${{ secrets.GH_PAGES_DEPLOY }} - - name: Release to GitHub Pages + - name: Deploy to GitHub Pages env: USE_SSH: true GIT_USER: git run: | git config --global user.email "actions@github.com" git config --global user.name "gh-actions" - if [ -e yarn.lock ]; then - yarn install --frozen-lockfile - elif [ -e package-lock.json ]; then - npm ci - else - npm i - fi - npm run deploy + yarn install --frozen-lockfile + yarn deploy ``` -1. Now when a new pull request arrives towards your repository in branch `documentation` it will automatically ensure that Docusaurus build is successful. -1. When pull request is merged to `documentation` branch or someone pushes to `documentation` branch directly it will be built and deployed to `gh-pages` branch. -1. After this step, your updated documentation will be available on the GitHub pages. +
+ + + +```` ### Triggering deployment with Travis CI {#triggering-deployment-with-travis-ci} Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and deploying changes to your website. All you need to do to automate the deployment of your website is to invoke the `yarn deploy` script whenever your website is updated. The following section covers how to do just that using [Travis CI](https://travis-ci.com/), a popular continuous integration service provider. 1. Go to https://github.com/settings/tokens and generate a new [personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/). When creating the token, grant it the `repo` scope so that it has the permissions it needs. -1. Using your GitHub account, [add the Travis CI app](https://github.com/marketplace/travis-ci) to the repository you want to activate. -1. Open your Travis CI dashboard. The URL looks like `https://travis-ci.com/USERNAME/REPO`, and navigate to the `More options` > `Setting` > `Environment Variables` section of your repository. -1. Create a new environment variable named `GH_TOKEN` with your newly generated token as its value, then `GH_EMAIL` (your email address) and `GH_NAME` (your GitHub username). -1. Create a `.travis.yml` on the root of your repository with the following: +2. Using your GitHub account, [add the Travis CI app](https://github.com/marketplace/travis-ci) to the repository you want to activate. +3. Open your Travis CI dashboard. The URL looks like `https://travis-ci.com/USERNAME/REPO`, and navigate to the `More options > Setting > Environment Variables` section of your repository. +4. Create a new environment variable named `GH_TOKEN` with your newly generated token as its value, then `GH_EMAIL` (your email address) and `GH_NAME` (your GitHub username). +5. Create a `.travis.yml` on the root of your repository with the following: -```yaml title=".travis.yml" +```yml title=".travis.yml" language: node_js node_js: - - '12.13.0' + - '14.15.0' branches: only: - main @@ -281,7 +399,8 @@ script: - git config --global user.name "${GH_NAME}" - git config --global user.email "${GH_EMAIL}" - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc - - yarn && GIT_USER="${GH_NAME}" yarn deploy + - yarn install + - GIT_USER="${GH_NAME}" yarn deploy ``` Now, whenever a new commit lands in `main`, Travis CI will run your suite of tests and if everything passes, your website will be deployed via the `yarn deploy` script. @@ -293,34 +412,35 @@ Now, whenever a new commit lands in `main`, Travis CI will run your suite of tes Follow these steps to create a pipeline that automatically deploys a new version of your website whenever you push changes to the selected branch of your project: 1. Go to https://github.com/settings/tokens and generate a new [personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/). When creating the token, grant it the `repo` scope so that it has the permissions it needs. -1. Sign in to your Buddy account and create a new project. -1. Choose GitHub as your git hosting provider and select the repository with the code of your website. -1. Using the left navigation panel, switch to the `Pipelines` view. -1. Create a new pipeline. Define its name, set the trigger mode to `On push`, and select the branch that triggers the pipeline execution. -1. Add a `Node.js` action. -1. Add these command in the action's terminal: - ```bash - GIT_USER= - git config --global user.email "" - git config --global user.name "" - yarn deploy - ``` +2. Sign in to your Buddy account and create a new project. +3. Choose GitHub as your git hosting provider and select the repository with the code of your website. +4. Using the left navigation panel, switch to the `Pipelines` view. +5. Create a new pipeline. Define its name, set the trigger mode to `On push`, and select the branch that triggers the pipeline execution. +6. Add a `Node.js` action. +7. Add these commands in the action's terminal: + +```bash +GIT_USER= +git config --global user.email "" +git config --global user.name "" +yarn deploy +``` After creating this simple pipeline, each new commit pushed to the branch you selected deploys your website to GitHub Pages using `yarn deploy`. Read [this guide](https://buddy.works/guides/react-docusaurus) to learn more about setting up a CI/CD pipeline for Docusaurus. ### Using Azure Pipelines {#using-azure-pipelines} -1. Sign Up at [Azure Pipelines](https://azure.microsoft.com/en-us/services/devops/pipelines/) if you haven't already. -1. Create an organization and within the organization create a project and connect your repository from GitHub. -1. Go to https://github.com/settings/tokens and generate a new [personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) with the `repo` scope. -1. In the project page (which looks like `https://dev.azure.com/ORG_NAME/REPO_NAME/_build` create a new pipeline with the following text. Also, click on edit and add a new environment variable named `GH_TOKEN` with your newly generated token as its value, then `GH_EMAIL` (your email address) and `GH_NAME` (your GitHub username). Make sure to mark them as secret. Alternatively, you can also add a file named `azure-pipelines.yml` at your repository root. +1. Sign Up at [Azure Pipelines](https://azure.microsoft.com/en-us/services/devops/pipelines/) if you haven't already. +2. Create an organization and within the organization create a project and connect your repository from GitHub. +3. Go to https://github.com/settings/tokens and generate a new [personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) with the `repo` scope. +4. In the project page (which looks like `https://dev.azure.com/ORG_NAME/REPO_NAME/_build` create a new pipeline with the following text. Also, click on edit and add a new environment variable named `GH_TOKEN` with your newly generated token as its value, then `GH_EMAIL` (your email address) and `GH_NAME` (your GitHub username). Make sure to mark them as secret. Alternatively, you can also add a file named `azure-pipelines.yml` at your repository root. -```yaml title="azure-pipelines.yml" +```yml title="azure-pipelines.yml" trigger: - main pool: - vmImage: 'ubuntu-latest' + vmImage: ubuntu-latest steps: - checkout: self @@ -328,33 +448,33 @@ steps: - task: NodeTool@0 inputs: - versionSpec: '10.x' - displayName: 'Install Node.js' + versionSpec: 14.x + displayName: Install Node.js - script: | git config --global user.name "${GH_NAME}" git config --global user.email "${GH_EMAIL}" git checkout -b main echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc - yarn && GIT_USER="${GH_NAME}" yarn deploy + yarn install + GIT_USER="${GH_NAME}" yarn deploy env: GH_NAME: $(GH_NAME) GH_EMAIL: $(GH_EMAIL) GH_TOKEN: $(GH_TOKEN) - displayName: 'yarn install and build' + displayName: Install and build ``` ### Using Drone {#using-drone} -1. Create a new ssh key that will be the [deploy key](https://docs.github.com/en/free-pro-team@latest/developers/overview/managing-deploy-keys#deploy-keys) for your project. -1. Name your private and public keys to be specific and so that it does not overwrite your other [ssh keys](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent). -1. Go to `https://github.com/USERNAME/REPO/settings/keys` and add a new deploy key by pasting in our public key you just generated. -1. Open your Drone.io dashboard and login. The URL looks like `https://cloud.drone.io/USERNAME/REPO`. -1. Click on the repository, click on activate repository, and add a secret called `git_deploy_private_key` with your private key value that you just generated. -1. Create a `.drone.yml` on the root of your repository with below text. +1. Create a new ssh key that will be the [deploy key](https://docs.github.com/en/free-pro-team@latest/developers/overview/managing-deploy-keys#deploy-keys) for your project. +2. Name your private and public keys to be specific and so that it does not overwrite your other [ssh keys](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent). +3. Go to `https://github.com/USERNAME/REPO/settings/keys` and add a new deploy key by pasting in our public key you just generated. +4. Open your Drone.io dashboard and login. The URL looks like `https://cloud.drone.io/USERNAME/REPO`. +5. Click on the repository, click on activate repository, and add a secret called `git_deploy_private_key` with your private key value that you just generated. +6. Create a `.drone.yml` on the root of your repository with below text. -```yaml -# .drone.yml +```yml title=".drone.yml" kind: pipeline type: docker trigger: @@ -368,13 +488,13 @@ trigger: - echo "$GITHUB_PRIVATE_KEY" > "$HOME/.ssh/id_rsa" - chmod 0600 $HOME/.ssh/id_rsa - cd website - - npm i - - npm run deploy + - yarn install + - yarn deploy environment: USE_SSH: true GIT_USER: $DRONE_COMMIT_AUTHOR GITHUB_PRIVATE_KEY: - from_secret: "git_deploy_private_key" + from_secret: git_deploy_private_key ``` Now, whenever you push a new tag to github, this trigger will start the drone ci job to publish your website. @@ -454,79 +574,63 @@ After your project has been imported, all subsequent pushes to branches will gen [Qovery](https://www.qovery.com) is a fully-managed cloud platform that runs on your AWS, Digital Ocean and Scaleway account where you can host static sites, backend APIs, databases, cron jobs, and all your other apps in one place. 1. Create a Qovery account. Visit the [Qovery dashboard](https://console.qovery.com) to create an account if you don't already have one. - -2. Create a project - -- Click on **Create project** and give a name to your project. -- Click on **Next**. - -3. Create a new environment - -- Click on **Create environment** and give a name (e.g. staging, production). - -4. Add an application - -- Click on **Create an application**, give a name and select your GitHub or GitLab repository where your Docusaurus app is located. -- Define the main branch name and the root application path. -- Click on **Create**. - -After the application is created: - -- Navigate to your application **Settings** -- Select **Port** -- Add port used by your Docusaurus application - -5. Deploy All you have to do now is to navigate to your application and click on **Deploy** +2. Create a project. + - Click on **Create project** and give a name to your project. + - Click on **Next**. +3. Create a new environment. + - Click on **Create environment** and give a name (e.g. staging, production). +4. Add an application. + - Click on **Create an application**, give a name and select your GitHub or GitLab repository where your Docusaurus app is located. + - Define the main branch name and the root application path. + - Click on **Create**. After the application is created: + - Navigate to your application **Settings** + - Select **Port** + - Add port used by your Docusaurus application +5. Deploy All you have to do now is to navigate to your application and click on **Deploy**. ![Deploy the app](https://hub.qovery.com/img/heroku/heroku-1.png) -That's it. Watch the status and wait till the app is deployed. - -To open the application in your browser, click on **Action** and **Open** in your application overview +That's it. Watch the status and wait till the app is deployed. To open the application in your browser, click on **Action** and **Open** in your application overview. ## Deploying to Hostman {#deploying-to-hostman} [Hostman](https://hostman.com/) allows you to host static websites for free. Hostman automates everything, you just need to connect your repository and follow easy steps: -1. Create a service - -To deploy a Docusaurus static website, click Create in the top-left corner of your [Dashboard](https://dashboard.hostman.com/) and choose Front-end app or static website. - -2. Select the project to deploy +1. Create a service. -If you are logged in to Hostman with your GitHub, GitLab or Bitbucket account, at this point you will see the repository with your projects, including the private ones. + To deploy a Docusaurus static website, click **Create** in the top-left corner of your [Dashboard](https://dashboard.hostman.com/) and choose **Front-end app or static website**. -Choose the project you want to deploy. It must contain the directory with the project’s files (usually it is website or my-website). +2. Select the project to deploy. -To access a different repository, click Connect another repository. + If you are logged in to Hostman with your GitHub, GitLab or Bitbucket account, at this point you will see the repository with your projects, including the private ones. -If you didn’t use your Git account credentials to log in, you’ll be able to access the necessary account now, and then select the project. + Choose the project you want to deploy. It must contain the directory with the project’s files (usually it is website or my-website). -3. Configure the build settings Next, the Website customization window will appear. + To access a different repository, click **Connect another repository**. -Choose the Static website option from the list of frameworks. + If you didn’t use your Git account credentials to log in, you’ll be able to access the necessary account now, and then select the project. -The Directory with app points at the directory that will contain the project's files after the build. You can leave it empty if during Step 2 you selected the repository with the contents of the website (or my_website) directory. +3. Configure the build settings. -The standard build command for Docusaurus will be: + Next, the **Website customization** window will appear. Choose the **Static website** option from the list of frameworks. -```bash -yarn run build -``` + The **Directory with app** points at the directory that will contain the project's files after the build. You can leave it empty if during Step 2 you selected the repository with the contents of the website (or `my_website`) directory. -You can modify the build command if needed. You can enter multiple commands separated by &&. + The standard build command for Docusaurus will be: -4. Deploy Click Deploy to start the build process. + ```bash npm2yarn + npm run build + ``` -Once it starts, you will enter the deployment log. If there are any issues with the code, you will get warning or error messages in the log, specifying the cause of the problem. + You can modify the build command if needed. You can enter multiple commands separated by `&&`. -Usually the log contains all the debugging data you'll need, but we are also here to help you solve the issues, so do not hesitate to contact us via chat. +4. Deploy. -When the deployment is complete, you will receive an e-mail notification and also see a log entry. + Click **Deploy** to start the build process. -All done! + Once it starts, you will enter the deployment log. If there are any issues with the code, you will get warning or error messages in the log, specifying the cause of the problem. Usually, the log contains all the debugging data you'll need. -Your project is up and ready. + When the deployment is complete, you will receive an email notification and also see a log entry. All done! Your project is up and ready. ## Deploying to Surge {#deploying-to-surge} @@ -535,22 +639,17 @@ Surge is a [static web hosting platform](https://surge.sh/help/getting-started-w Deploy your app in a matter of seconds using surge with the following steps: 1. First, install Surge using npm by running the following command: - -```bash -npm install --g surge -``` - + ```bash npm2yarn + npm install -g surge + ``` 2. To build the static files of your site for production in the root directory of your project, run: - -```bash -npm run build -``` - + ```bash npm2yarn + npm run build + ``` 3. Then, run this command inside the root directory of your project: - -```bash -surge build/ -``` + ```bash + surge build/ + ``` First-time users of Surge would be prompted to create an account from the command line(happens only once). @@ -579,19 +678,14 @@ You can deploy any other changes in the future with the command `surge`. ## Deploying to QuantCDN {#deploying-to-quantcdn} 1. Install [Quant CLI](https://docs.quantcdn.io/docs/cli/get-started) - 2. Create a QuantCDN account by [signing up](https://dashboard.quantcdn.io/register) - 3. Initialize your project with `quant init` and fill in your credentials: - -```bash -quant init -``` - -4. Deploy your site - -```bash -quant deploy -``` + ```bash + quant init + ``` +4. Deploy your site. + ```bash + quant deploy + ``` See [docs](https://docs.quantcdn.io/docs/cli/continuous-integration) and [blog](https://www.quantcdn.io/blog) for more examples and use cases for deploying to QuantCDN.