asyncapi / generator

Use your AsyncAPI definition to generate literally anything. Markdown documentation, Node.js code, HTML documentation, anything!
https://asyncapi.com/docs/tools/generator
Apache License 2.0
755 stars 211 forks source link

Template list workflow runs on every forked repository #921

Open sambhavgupta0705 opened 1 year ago

sambhavgupta0705 commented 1 year ago

Describe the bug

Everyday github runs a workflow based on templates-list-validator . The bug here is that this workflow runs on every forked repository also, which I think is not the aim of this workflow.

How to Reproduce

Steps to reproduce the issue. Attach all resources that can help us understand the issue:

This issue can be resolved by adding an if statement which checks for only asyncapi repository.

Expected behavior

A clear and concise description of what you expected to happen.

sambhavgupta0705 commented 1 year ago

@derberg can you please approve this issue. Here cron jobs is doing work correctly,just an error here is that it is running test on every forked repository also

sambhavgupta0705 commented 1 year ago
jobs:
  templates:
    if: startsWith(github.repository, 'asyncapi/')
    name: 'Check list of templates'

Proposed solution for this

derberg commented 1 year ago

To be honest I think it is about time to probably remove the whole workflow and related custom action and instead, we should just make sure all templates are listed in https://www.asyncapi.com/tools πŸ€”

sambhavgupta0705 commented 1 year ago

To be honest I think it is about time to probably remove the whole workflow and related custom action and instead, we should just make sure all templates are listed in https://www.asyncapi.com/tools πŸ€”

So what should we do for now??

derberg commented 1 year ago

well we need to create 13 PRs in different repos to add .asyncapi-tool file there πŸ˜„

example:

title: .NET RabbitMQ
filters:
    language: 'C#'
    technology:
        - AsyncAPI Generator
        - '.NET'
        - RabbitMQ
    categories:
        - code-generator
    hasCommercial: false

I'm only thinking that because there are so many AsyncAPI Generator templates, and more will come, that maybe we need a separate category for it. @akshatnema thoughts?

sambhavgupta0705 commented 1 year ago

I would like to work on this oneπŸ˜€

akshatnema commented 1 year ago

I'm only thinking that because there are so many AsyncAPI Generator templates, and more will come, that maybe we need a separate category for it.

Sorry, I didn't understand what you mean by separate category. Do you want to add any category inside categorylist?

well we need to create 13 PRs in different repos to add .asyncapi-tool file there

I will definitely say NO to this. Because currently, you also know that Github API is not returning correct results to us via. Increasing this number of files increases the payload of the results of the API call, thus decreasing the probability of getting correct result in a script run. So, if you want to add any tool, please add it to tools-manual.json until we get a new version of GitHub Code search API.

derberg commented 1 year ago

Sorry, I didn't understand what you mean by separate category. Do you want to add any category inside categorylist?

I mean that AsyncAPI Generator involves so many repositories/projects that it could also have own category, like asyncapi-generator so one can say:

categories:
        - code-generator
        - asyncapi-generator

tools-manual.json

oh, I definitely do not like this direction πŸ˜ƒ

akshatnema commented 1 year ago

oh, I definitely do not like this direction

Yeah, I too don't like this to add manual tools if we have the option of .asyncapi-tool file. But due to the payload of the API and incomplete results, we can't exceed the information extracted from the API.

derberg commented 1 year ago

But wasn't it working this way that on local you did not face any issues?

sambhavgupta0705 commented 1 year ago

Hey @derberg what should we do with this one???

github-actions[bot] commented 1 year ago

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

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 :heart:

github-actions[bot] commented 6 months ago

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

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 :heart:

AnimeshKumar923 commented 6 months ago

still valid? @sambhavgupta0705 @akshatnema @derberg

sambhavgupta0705 commented 6 months ago

Yes it is Still it runs the pr check on every forked repo

lmgyuan commented 3 months ago

The problematic workflow seems to be removed already. If anyone is having a same or similar issue, please make sure to update their fork master with latest upstream master. It should fix the issue.

derberg commented 1 month ago

we still don't have all the tools listed in https://www.asyncapi.com/tools#AsyncAPI%20Generator%20Templates

going with .asyncapi-tool in each repo no longer makes sense cause plans are eventually to pull templates into generator repo. I think best if someone finds time to manually add the templates that we have in readme by following this procedure https://github.com/asyncapi/community/blob/master/new-tool-documentation.md#manual-addition-of-tools