Skip to content

Latest commit

 

History

History
32 lines (25 loc) · 2.07 KB

RELEASE.md

File metadata and controls

32 lines (25 loc) · 2.07 KB
Raw

Release Guide

Automated Deployments

The Stencil documentation site is automatically deployed to Vercel when a pull request is merged into the main branch. Changes to the doc site are therefore designed to automatically happen - with a few exceptions. If you have merged code to main and it has not deployed to Vercel, please see the Vercel dashboard for additional debugging.

Creating a New Version Section

This section describes how to generate a new section of the docs that coincides with releasing a new major/minor version of Stencil.

The Stencil team uses Docusaurus' Versioning to create new documentation for new major and minor versions of Stencil core. The creation of a new version requires some manual work. Once a new version has been created, a pull request containing the new version can be created/merged. Once that pull request is merged, the new version will be automatically deployed to Vercel.

Docusaurus creates a new version of the documentation based on the contents of the root level docs/ directory in this project. When generating a new version, it is assumed that all changes for the soon to be created new versions have already landed in the main branch.

To generate a new version:

  1. Ensure there are no changes in your local repository
  2. Ensure that you have the latest version of main - git checkout main && git pull
    1. This is important, as a rebase/merge with main later will not catch any changes in docs/ that you don't have locally
  3. Check out a new branch to host the changes
  4. Generate a new release - npm run docusaurus docs:version v[VERSION]
    1. VERSION will be the value that is seen in the dropdown on the documentation site. e.g. npm run docusaurus docs:version v4.1 will generate a 'v4.1' version
  5. Commit your changes, push the branch, and create a pull request
  6. Merging the Pull Request:
    1. Only one approval is need to merge the pull request
    2. Merging the pull request should coincide with the release of Stencil Core, as the doc site automatically deploys to Vercel