asyncapi / parser-js

AsyncAPI parser for Javascript (browser-compatible too).
115 stars 91 forks source link

Changeset Add Release Action using Changeset #1028

Open ayushnau opened 1 month ago

ayushnau commented 1 month ago

Why do we need this improvement?

Currently, we are using Semantic Release for our versioning and package publishing. However, as we transition to a monorepo setup, we require the capability to push to multiple GitHub and npm registries. Semantic Release does not support this functionality out of the box, necessitating the integration of Changeset for our release process.

How will this change help?

By incorporating Changeset as our release tool, we can streamline the management and publishing process across multiple npm and GitHub registries. This will enable us to handle monorepos more efficiently and maintain better control over our package distribution.

Screenshots

No response

How could it be implemented/designed?

Add GitHub Action File:

Create a GitHub Action workflow file in your repository (e.g., .github/workflows/release.yml).
Configure the workflow to trigger on relevant events (e.g., push, pull request, etc.).
Define the steps to install dependencies, run tests, and execute Changeset for releasing.

Update package.json:

Add the necessary Changeset dependencies to your package.json file.
Include scripts for managing Changeset operations (e.g., release, bump, etc.).

🚧 Breaking changes

Yes

👀 Have you checked for similar open issues?

🏢 Have you read the Contributing Guidelines?

Are you willing to work on this issue?

Yes I am willing to submit a PR!

github-actions[bot] commented 1 month ago

Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Please check out our contributors guide and the instructions about a basic recommended setup useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.