0.1.5 • Published 7 months ago

releaset v0.1.5

Weekly downloads
-
License
MIT
Repository
github
Last release
7 months ago

Releaset

Releaset is designed to automatically generate changelogs for your repositories by CLI.

Why Releaset?

  • Auto Changelogs: Generate changelogs based on git tag and git commit history.
  • CICD Friendly: Embed the command in your CICD work flow to update changelogs automatically.
  • Pre-release Friendly: Support pre-relase and production publishing.
  • Support Publish Note: Update .releaset/publish_note.json manually set publish note for each version.

Prerequisites

Ensure your project uses semantic versioning for git tags.

Example

Releaset uses this command to generate logs:

npx releaset --projectUrl https://github.com/AlfredChow2338/releaset --title @Releaset --filterCommit Release

CHANGELOG Example

Project applied pre-release practice and want to publish production logs in CHANGELOG.md:

npx releaset --projectUrl {PROJECT_URL} \
  --title {LOG_FILE_TITLE}
  --prTag {PR_TAG}

Project applied pre-release practice and publish pre-release logs in CHANGELOG_PR.md:

npx releaset --projectUrl {PROJECT_URL} \
  --title {LOG_FILE_TITLE}
  --prTag {PR_TAG} \
  --pr

Export CHANGELOG which tags contain specific tag identifier:

npx releaset --projectUrl {PROJECT_URL} \
  --title {LOG_FILE_TITLE}
  --filterTag {FILTER_TAG}

Output CHANGELOG to specified directory eg. packages/foo:

npx releaset --projectUrl {PROJECT_URL} \
  --title {LOG_FILE_TITLE}
  --outDir packages/foo

Installation

No installation is needed. We suggest directly use the npx releaset command for ease.

Pre-release version

The script will create a changelog file:

  • Pre-release mode: CHANGELOG_PR.md
  • Production mode: CHANGELOG.md

info.json will also be created to record all releaset information. No change is needed for this configuration file.

Publish note

publish_note.json will be created if arguements ver and note are passed.

You can manually update publish_note.json to list the publish note in each version.

JSON Structure: [TAG]: [PUBLISH_NOTE]

0.1.5

7 months ago

0.1.4

8 months ago

0.1.3

8 months ago

0.1.2

8 months ago

0.1.1

8 months ago

0.1.0

8 months ago

0.0.40

8 months ago

0.0.39

8 months ago

0.0.38

8 months ago

0.0.37

8 months ago

0.0.36

8 months ago

0.0.35

8 months ago

0.0.34

8 months ago

0.0.33

8 months ago

0.0.32

8 months ago

0.0.31

8 months ago

0.0.30

8 months ago

0.0.29

8 months ago

0.0.28

8 months ago

0.0.27

8 months ago

0.0.26

8 months ago

0.0.25

8 months ago

0.0.24

8 months ago

0.0.23

8 months ago

0.0.22

8 months ago

0.0.18

8 months ago

0.0.17

8 months ago

0.0.14

8 months ago

0.0.13

8 months ago

0.0.12

8 months ago

0.0.11

8 months ago

0.0.10

8 months ago

0.0.9

8 months ago

0.0.8

8 months ago

0.0.7

8 months ago

0.0.6

8 months ago

0.0.5

8 months ago

0.0.4

8 months ago

0.0.3

8 months ago

0.0.2

8 months ago

0.0.1

8 months ago