https://github.com/wangziling100/autopublish
SemVer publish for monorepo
https://github.com/wangziling100/autopublish
Last synced: 3 months ago
JSON representation
SemVer publish for monorepo
- Host: GitHub
- URL: https://github.com/wangziling100/autopublish
- Owner: wangziling100
- License: mit
- Created: 2020-08-05T12:01:45.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2023-03-13T08:57:52.000Z (over 2 years ago)
- Last Synced: 2025-03-19T23:46:59.949Z (3 months ago)
- Language: JavaScript
- Size: 382 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Introduction
This project provides an automatic publishing solution based on monorepo, presented in the form of Github Action. Action will analyze the user's Git Commit, and then publish the corresponding module according to the regulations. The specific regulations are as follows:
- Action acts on branches master, next, alpha, beta, N.x, N.N.x
- Branch naming rules: \@@\
- commit follows the form of "\: \@@\
- Commit type has "init", "feat", "fix", "breaking change"
- workspace is the module to be published
- If the workplace is not set, the action publishes for the entire project
- The publishing action follows the [decision table](https://github.com/wangziling100/AutoPublish/issues/4)
# Quick Start
```yml
name: Node.js Auto Publish
on:
push
jobs:
publish:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v1
with:
node-version: 12
- uses: wangziling100/[email protected]
with:
scope: '@wangziling100'
strict_error: false
env:
NPM_TOKEN: ${{secrets.NPM_TOKEN}}
```
No parameters are required, but usually you need to set scope and NPM_TOKEN
## Parameter Descriptions
- scope: Scope of your package
- root_dir: Root directory of your monorepo
- strict_error: If it is true, it will report an error once it is not successfully published. If it is false, it will ignore the commit format error.
# Example
This action will not generate a release every time a module is published, but it will generate a tag for this module, like [this](https://github.com/wangziling100/AutoPublishTest/tags).
More examples see [here](https://github.com/wangziling100/AutoPublishTest/actions)