Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Automation testing for MD files #3215

Open
sambhavgupta0705 opened this issue Sep 11, 2024 · 11 comments · May be fixed by #3301
Open

Automation testing for MD files #3215

sambhavgupta0705 opened this issue Sep 11, 2024 · 11 comments · May be fixed by #3301
Assignees
Labels
bounty AsyncAPI Bounty program related label enhancement

Comments

@sambhavgupta0705
Copy link
Member

sambhavgupta0705 commented Sep 11, 2024

Why do we need this improvement?

Sometimes some MD files doesn't get rendered for which we doesn't get notify .For this we need to setup a workflow which notify us whenever any md files doesn't get rendered .

@lucky29-git
Copy link

@sambhavgupta0705 can I work in this issue, if you can guide me a bit?
Do you think creating a github actions workflow will be enough?

@sambhavgupta0705
Copy link
Member Author

@lucky29-git I have submitted this as bounty issue and one of the maintainer will be working on it

@lucky29-git
Copy link

lucky29-git commented Sep 13, 2024

Okay sir 🙌,
which Slack channel should I use to ask my questions and connect with you? @sambhavgupta0705

@sambhavgupta0705
Copy link
Member Author

You can start communication on #11 contributing

@asyncapi-bot asyncapi-bot added the bounty AsyncAPI Bounty program related label label Sep 16, 2024
@aeworxet
Copy link
Contributor

Bounty Issue's service comment

Text labels: bounty/2024-Q4, bounty/medium, bounty/coding
First assignment to regular contributors: 2024-09-20 00:00:00 UTC+12:00
End Of Life after: 2024-10-31 23:59:59 UTC-12:00

@asyncapi/bounty_team

The Bounty Program is not a Mentorship Program. The accepted level of Bounty Program Participants is Middle/Senior.
Regular contributors should explain in meaningful words how they are going to approach the resolution process when expressing a desire to work on this Bounty Issue.

@anshgoyalevil
Copy link
Member

Hey @aeworxet. I would like to take up this issue as a maintainer of this repo.

@anshgoyalevil anshgoyalevil self-assigned this Sep 16, 2024
@aeworxet
Copy link
Contributor

Bounty Issue's Timeline

Complexity Level Assignment Date (by GitHub) Start Date (by BP Rules) End Date (by BP Rules) Draft PR Submission Final PR Merge Start Final PR Merge End
Medium 2024-09-16 2024-10-07 2024-11-17 2024-10-20 2024-11-03 2024-11-17
Please note that the dates given represent deadlines, not specific dates, so if the goal is reached sooner, it's better.
Keep in mind the responsibility for violations of the Timeline.

@anshgoyalevil
Copy link
Member

anshgoyalevil commented Oct 12, 2024

Due to a lot of mixed imports (ESM files), We can't really test the jsdom along with node environment. Got this finding after playing around with jest, RTL, and mdx transformer that is transpiling the mdx files along with import imports. We need to halt this issue until #3187 gets completed.

Any opinions? @akshatnema
//cc @aeworxet

@akshatnema
Copy link
Member

@anshgoyalevil Can we create this script in a ESM module in a separate folder? If you want, we can have a separate folder with a package.json configured for ESM to test it in a workflow.

Later on, after complete migration in ESM, we can then delete this temporary package.json and will integrate this workflow in existing scripts.

@aeworxet
Copy link
Contributor

@akshatnema, @anshgoyalevil

Has any decision been made regarding this? Will there be a workaround or will there be a halt until the completion of #3187?

@anshgoyalevil
Copy link
Member

@aeworxet Akshat and I had a discussion to implement the static testing on md files.

I will be creating the PR soon. There will be no halt thus.

@anshgoyalevil anshgoyalevil linked a pull request Oct 18, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bounty AsyncAPI Bounty program related label enhancement
Projects
Status: In Progress
Development

Successfully merging a pull request may close this issue.

6 participants