Files

Shahed Nasser 66e8f4e0d2 docs-util: fix release scripts (#6353 )

- Fix GitHub action to run on push and check if the commit message is "chore: Release". Only then are TSDocs generated and a PR is opened.
- Add an option to pass to the `run:release` method of the docblock generator a release tag. This is helpful in cases when the GitHub action fails for any reason.
- Add scripts that checks the message of a commit.

2024-02-08 20:36:27 +00:00

src

docs-util: fix release scripts (#6353 )

2024-02-08 20:36:27 +00:00

.env.sample

docs-util: created docblock-generator tool (#6096 )

2024-01-24 11:13:40 +01:00

package.json

docs: change process for generating docblocks through actions (#6237 )

2024-01-29 08:05:14 +00:00

README.md

docs-util: created docblock-generator tool (#6096 )

2024-01-24 11:13:40 +01:00

tsconfig.json

docs-util: created docblock-generator tool (#6096 )

2024-01-24 11:13:40 +01:00

README.md

docblock-generator

A CLI tool that can be used to generate TSDoc docblocks for TypeScript/JavaScript files under the packages directory of the main monorepo.

Prerequisites

Run the yarn command to install dependencies.
Copy the .env.sample to .env and change the MONOREPO_ROOT_PATH variable to the absolute path to the monorepo root.

Usage

Generate for a specific file

Run the following command to run the tool for a specific file:

yarn start run /absolute/path/to/file.ts

Generate for git-changed files

Run the following command to run the tool for applicable git file changes:

yarn start run:changes

Generate for a specific commit

Run the following command to run the tool for a commit SHA hash:

yarn start run:commit <commit-sha>

Where <commit-sha> is the SHA of the commit. For example, e28fa7fbdf45c5b1fa19848db731132a0bf1757d.