Show how to incorporate the library into workflows

[jonaslagoni]

Reason/Context

It would be nice to show how to use the library in different workflows.

For example, how to incorporate it into a GH action workflow.

Example usage:

name: Convert the AsyncAPI document
env:
  GH_USER: jonaslagoni
  GH_EMAIL: <jonas-lt@live.dk>
on:
  workflow_dispatch: 
jobs:
  convert:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v2
      - uses: actions/setup-node@v2
        with:
          node-version: '14'
      - name: Install converter
        run: npm i -g @asyncapi/converter 
      - name: Convert AsyncAPI file
        run: asyncapi-converter ./asyncapi.json > ./asyncapi-temp.json && mv ./asyncapi-temp.json ./asyncapi.json
      - name: Create Pull Request with updated document
        uses: peter-evans/create-pull-request@v3
        with:
          token: '${{ secrets.GH_TOKEN }}'
          commit-message: 'feat: convert to newest AsyncAPI version'
          committer: '${{env.GH_USER}} ${{env.GH_EMAIL}}'
          author: '${{env.GH_USER}} ${{env.GH_EMAIL}}'
          title: 'feat: convert to newest AsyncAPI version'
          body: Update to newest AsyncAPI version
          branch: 'convert/asyncapi_file'

[magicmatatjahu]

@jonaslagoni Could you create PR with that? :) I will be very happy.

[jonaslagoni]

Dont have the bandwidth for it atm, mind putting it under good first issue?

[magicmatatjahu]

We should go with our CLI solution -> asyncapi/diff#79 (comment)

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity 😴

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity 😴

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️

[SuyashPatil-29]

I would love to contribute to this. It would be my first open source contribution so I would require some help and guidance.
@magicmatatjahu @derberg @jonaslagoni

[derberg]

@SuyashPatil-29 how much are you experienced with coding, docker and GH actions? Do not worry about open source experience, we are here to help.

so basically what has to be done is described in asyncapi/github-action-for-cli#281

you sure you want to pick this up as first contribution, or maybe some other issue, this one for sure is no longer a good-first-issue

[magicmatatjahu]

Yep, issue is not easy, you need to know how github workflows works and also you have to test it in your repo.

[SuyashPatil-29]

@derberg I can work with React.js Node.js JavaScript and have Java, C and C++ experience too.
I have learnt Java, C++ in my previous years of high school and C in my 1st semester of engineering (which I am in currently) and right now I am learning JavaScript and frontend and backend frameworks for web development and open source.

And coming to GitHub, I am pretty new and I am finding my way around but I think I can handle issues and pr's and contribute using branches too

If you could suggest me other good-first-issues related to my field, it would be pretty useful

[derberg]

@SuyashPatil-29 how about https://github.com//asyncapi/cli/issues/302 ? Solving this one would help us a lot

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity 😴

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️

[jonaslagoni]

Closing as we now have it part of the CLI