diff --git a/.release/release-notes.md b/.release/release-notes.md index 21fc69d..a485c39 100644 --- a/.release/release-notes.md +++ b/.release/release-notes.md @@ -1,3 +1,5 @@ +## Fixes +- Wait for flags task to complete before exit + ## Changes -- Update the action registry to handle error -- Able to listen to action and release flags \ No newline at end of file +- Updated documentation \ No newline at end of file diff --git a/package.json b/package.json index 34a16f7..7ad6a10 100644 --- a/package.json +++ b/package.json @@ -14,7 +14,7 @@ }, "exports": "./dist/index.js", "bin": { - "xmanscript": "dist/index.js" + "xmanscript-test": "dist/index.js" }, "repository": { "type": "git", diff --git a/readme.md b/readme.md index eef27db..b261863 100644 --- a/readme.md +++ b/readme.md @@ -1,10 +1,26 @@ -## xmanscript-cli-beta -#### for `xmanscript` tools +# xmanscript-cli-beta + +## Description +The `xmanscript-cli` is a command-line interface (CLI) tool designed to streamline the development process for projects utilizing the `xmanscript` tools. It aims to reduce the overhead of copying and pasting boilerplates and configurations for frontend and backend applications built in JavaScript. Additionally, it facilitates the building and deployment of npm packages. + +## Usage + +### Installation +To use `xmanscript-cli`, ensure you have Node.js installed on your system. You can then run the following command to utilize the tool without the need for global installation: -Run: ```bash - npx xmanscript +npx xmanscript ``` -and follow the prompts. +### Command-Line Interface +After running the command above, follow the prompts to perform various tasks related to managing your JavaScript projects. +### Help +To see the available flags and options, you can use the --help flag: +```bash +npx xmanscript --help +``` + +## Motivation +The primary motivation behind the development of `xmanscript-cli` is to simplify and automate common tasks encountered during JavaScript project development. By abstracting away boilerplate code and configuration setup, developers can focus more on building features and less on repetitive setup tasks. + +Whether you're starting a new frontend or backend application or packaging and deploying an npm package, `xmanscript-cli` aims to streamline the process, making development more efficient and enjoyable. -Happy coding 🚀. \ No newline at end of file diff --git a/src/index.ts b/src/index.ts index b18cb21..c8b26f7 100644 --- a/src/index.ts +++ b/src/index.ts @@ -21,10 +21,10 @@ async function main() { showAvailableFlags(); process.exit(0); } else if (flags["create-release-data"]) { - createRelease(); + await createRelease(); process.exit(0); } else if (flags["create-release-action"]) { - createReleaseWorkflow(); + await createReleaseWorkflow(); process.exit(0); } else { console.error("Flag not available.");