Home

Awesome

[READ ONLY] Subtree split of the siyuan-packages-monorepo /workspace/plugins/typewriter

<div align="center"> <img alt="icon" src="./public/icon.png" style="width: 8em; height: 8em;">

GitHub release (latest by date including pre-releases) GitHub Release Date GitHub License GitHub last commit GitHub repo size hits

<!-- ![jsDelivr hits (GitHub)](https://img.shields.io/jsdelivr/gh/hy/Zuoqiu-Yingyi/siyuan-packages-typewriter?style=flat-square) -->

GitHub all releases


</div>

USER GUIDE

简体中文 | English

DEVELOPER GUIDE

RELEASE STEPS

  1. Update the version number in <subrepo-root-dir>/package.json and <subrepo-root-dir>/public/plugin.json, then commit the changes in monorepo.
  2. Run script ./scripts/git-subtree/typewriter/push.ps1 with the folowing command in monorepo root dir to push the subtree to sub-repository (dev branch).
    pwsh -f "./scripts/git-subtree/typewriter/push.ps1"
    
  3. Create a pull request from dev branch to main branch in sub-repository.
  4. Merge the pull request.
  5. Await for the CD workflow release-please.yml to complete, it will create a release pull request in sub-repository.
  6. Merge the release pull request, it will create a new pre-release with current changelog and a new tag with semantic version in sub-repository.
  7. Await for the CD workflow build.yml to complete, it will update the distribution files to publish branch in sub-repository.
  8. Await for the CD workflow release-distribution.yml to complete, it will create a new pre-release with an asset named package.zip and a new tag with timestamp in sub-repository.

CHANGELOG

CHANGE LOG