https://github.com/zuoqiu-yingyi/siyuan-plugin-template

[READ ONLY] Subtree split of the siyuan-packages-monorepo (see https://github.com/Zuoqiu-Yingyi/siyuan-packages-monorepo)
https://github.com/zuoqiu-yingyi/siyuan-plugin-template

siyuan siyuan-note siyuan-plugin subtree subtree-split template template-project

Last synced: 26 days ago
JSON representation

[READ ONLY] Subtree split of the siyuan-packages-monorepo (see https://github.com/Zuoqiu-Yingyi/siyuan-packages-monorepo)

• Host: GitHub
• URL: https://github.com/zuoqiu-yingyi/siyuan-plugin-template
• Owner: Zuoqiu-Yingyi
• License: agpl-3.0
• Created: 2023-08-16T05:27:11.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-12-06T14:03:38.000Z (over 1 year ago)
• Last Synced: 2025-02-06T22:14:32.719Z (3 months ago)
• Topics: siyuan, siyuan-note, siyuan-plugin, subtree, subtree-split, template, template-project
• Language: TypeScript
• Homepage: https://github.com/Zuoqiu-Yingyi/siyuan-packages-monorepo/tree/main/workspace/plugins/template
• Size: 9.43 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
> **[READ ONLY] Subtree split of the [siyuan-packages-monorepo](https://github.com/Zuoqiu-Yingyi/siyuan-packages-monorepo) [/workspace/plugins/template](https://github.com/Zuoqiu-Yingyi/siyuan-packages-monorepo/tree/main/workspace/plugins/template)**





---

[![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/Zuoqiu-Yingyi/siyuan-plugin-template?include_prereleases&style=flat-square)](https://github.com/Zuoqiu-Yingyi/siyuan-plugin-template/releases/latest)

[![GitHub Release Date](https://img.shields.io/github/release-date/Zuoqiu-Yingyi/siyuan-plugin-template?style=flat-square)](https://github.com/Zuoqiu-Yingyi/siyuan-plugin-template/releases/latest)

[![GitHub License](https://img.shields.io/github/license/Zuoqiu-Yingyi/siyuan-plugin-template?style=flat-square)](https://github.com/Zuoqiu-Yingyi/siyuan-plugin-template/blob/main/LICENSE)

[![GitHub last commit](https://img.shields.io/github/last-commit/Zuoqiu-Yingyi/siyuan-plugin-template?style=flat-square)](https://github.com/Zuoqiu-Yingyi/siyuan-plugin-template/commits/main)

![GitHub repo size](https://img.shields.io/github/repo-size/Zuoqiu-Yingyi/siyuan-plugin-template?style=flat-square)

![GitHub code size](https://img.shields.io/github/languages/code-size/Zuoqiu-Yingyi/siyuan-plugin-template.svg?style=flat-square)

![hits](https://hits.b3log.org/Zuoqiu-Yingyi/siyuan-plugin-template.svg)

[![GitHub all releases](https://img.shields.io/github/downloads/Zuoqiu-Yingyi/siyuan-plugin-template/total?style=flat-square)](https://github.com/Zuoqiu-Yingyi/siyuan-plugin-template/releases)

---



## USER GUIDE

[简体中文](./public/README_zh_CN.md) \| [English](./public/README.md)

## DEVELOPER GUIDE

### RELEASE STEPS

1. Update the version number in `/package.json` and `/public/plugin.json`, then commit the changes in [monorepo](https://github.com/Zuoqiu-Yingyi/siyuan-packages-monorepo).

2. Run script `./scripts/git-subtree/template/push.ps1` with the folowing command in **monorepo root dir** to push the subtree to sub-repository (`dev` branch).

   ```powershell

   pwsh -f "./scripts/git-subtree/template/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](./CHANGELOG.md) and a new *tag* with [semantic version](https://semver.org/) 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](./CHANGELOG.md)