oak-sdk

oak-sdk

This README provides detailed instructions on how to use the automated publishing script included with this TypeScript npm package. The script automates the processes of building, versioning, and publishing the package, simplifying maintenance and release tasks.

Prerequisites

Before using the publishing script, make sure you have the following installed:

• Node.js and npm
• Git

You should also have an npm account set up and configured on your machine via npm login.

Installation

1. Clone the Repository: To get started, clone this repository to your local machine and navigate into the project directory:

   git clone <repository-url>
   cd <repository-name>

2. Install Dependencies: Install the project dependencies to ensure the package builds correctly:

   npm install

Using the Publish Script

The ./scripts/publish.sh script is designed to automate the following tasks:

1. Build the TypeScript project.
2. Automatically increment the project's version.
3. Publish the package to npm.

Steps to Run the Script

1. Make the Script Executable: Before running the script for the first time, ensure it is executable:

   chmod +x ./scripts/publish.sh

2. Execute the Script: To run the publishing script, use the following command:

   ./scripts/publish.sh

Detailed Actions of the Script

• Build: Compiles the TypeScript source files to JavaScript, ensuring all changes are included.
• Version Update: Uses npm version patch to update the package version. Modify the patch keyword to minor or major as needed for your versioning schema.
• Publish: The script uploads the compiled package to npm.

Modifying the Script

If you need to customize the versioning strategy or add pre-publish steps like running tests, you can edit the ./scripts/publish.sh script. Simply open it in your text editor and adjust the commands as needed.

Troubleshooting

• Permission Errors: If you encounter errors related to permissions, verify that you have executable rights for the script, and the necessary permissions for npm and Git operations.
• Login Issues: Confirm that you are logged into npm and Git. If you encounter login issues, re-authenticate using npm login and check your Git configuration.

Conclusion

Using the ./scripts/publish.sh script should help streamline your development and release processes by automating routine tasks such as building, versioning, and publishing your package. This ensures a consistent approach to package releases.

For more detailed information on npm versioning and package management, refer to the npm documentation.