feat: validate workflow schema

[Namyalg]

Description

This PR consists of a script and a workflow that validates the yml schema of a workflow file

Related issue(s)
Issue #150

This is sample run on 2 erroneous files

[derberg]

Thanks a lot. I made few suggestions. Once you apply them, please show workflow in action in some test repo

[Namyalg]

@derberg , In case 2 or more yml files are created during a PR, and the first one fails, currently the action will stop at the first failed file. Is it a good idea to do this or validate both the files and then report the error ?

[derberg]

@Namyalg best developer experience would be to validate all the files and throw error at the end of validation with list of all affected files, end related errors

just catch errors into a Map where you keep filename and error and then at the end, if size is bigger than 0 just throw error with all details

[Namyalg]

Okay, working on this

[Namyalg]

I have made the changes suggested

This is a sample workflow run on erroneous workflow files

This is sample on a file adhering to the schema

Few points :

• The JSON schema has been stored in a file in scripts . I was facing some issues due to the async call to axios, hence fs.readFileSync has been used
• On encountering errors in file(s), the name of the file and the log is shown. The workflow fails (using actions/@core)
• Without installing actions/@core, a package not found error occurred (As it was earlier mentioned that actions/@core is a part of the actions/github-script action)

[derberg]

looking better, left some comments, please have a look

[derberg]

can we make sure it check only changes in files in .github/workflows ?

[derberg]

@Namyalg hey, need a hand?

[Namyalg]

Hey @derberg, working on the changes

[derberg]

@Namyalg fyi there are still 2 not addressed comments

[Namyalg]

Hey @derberg, apologize for the delay.
The script to validate schemas reads from the URL, based on the reference script written by @KhudaDad414

[derberg]

@Namyalg no worries 👍🏼

@KhudaDad414 can you please have another look?

[KhudaDad414]

Let's see this in action :) thanks @Namyalg 👏

[Namyalg]

Shall I delete the test file one and two created for verification ?

[KhudaDad414]

@Namyalg sure, since we do not need them.

[Namyalg]

Done with the deletions 👍

[derberg]

We are almost ready to go, but since the creation of this PR, some changes were introduces in project in regards to "global" files.

• You need to add this new workflow explicitly to https://github.com/asyncapi/.github/blob/master/.github/workflows/global-replicator.yml#L134 list
• You need to move JS script to workflows/scripts and add there to the script a comment on what is this script used for. If for my other comment, you go with package.json and package-lock.json then you will need to add there a folder for the script and related files

Lemme know if you need more explanation

[Namyalg]

Okay @derberg , will look into it

[derberg]

@Namyalg need help?

[derberg]

@Namyalg I hope you plan to complete it as you spent a lot of time on it.

We have one contributor that is willing to complete it for you, but I want to make sure you are ok with it

[Namyalg]

Hello @derberg , working on it.
I would like to collaborate with the other contributor.

[derberg]

@14Richa I know you were interested to help with this one
@Namyalg thanks for quick response 🙏

[14Richa]

Hey @Namyalg, let me know if you need any help. You can ping me on slack as well. :)

Always happy to help!!

[14Richa]

Thanks, @derberg. I will get in touch with @Namyalg and make the pr ready to merge asap together. :)

[derberg]

any success? maybe we should just start from scratch?

we need this validation as we have lots of workflows, and I caused some errors recently just because of syntax error in a workflow 🙃 😄

[Namyalg]

Yes, I think we can start from scratch @derberg
Where should I get started ?

[derberg]

@Namyalg if you want to continue with this one, no need to start from scratch. There are minor stuff left. I suggested from scratch in case you want to let it go.

did you have a change to sync with @14Richa and get some help? Both of you are in our Slack

[KhudaDad414]

closing since it has been done here: #238