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

docs: add the development guide on how to run test #1250

Open
wants to merge 8 commits into
base: master
Choose a base branch
from

Conversation

Gmin2
Copy link
Collaborator

@Gmin2 Gmin2 commented Aug 10, 2024

Description

Added a guide on how to run test locally and in isolated docker enviorment.

Related issue(s)
Fixes #1248

Copy link

changeset-bot bot commented Aug 10, 2024

⚠️ No Changeset found

Latest commit: e429089

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Member

@derberg derberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

since we have a release process described in readme, don't you want dev guide to be there too?

I think that for consistency, we should have both either in main readme, or both just mentioned in readme and details in separate markdown files

@lmgyuan thoughts on this one?

Development.md Outdated Show resolved Hide resolved
Development.md Outdated Show resolved Hide resolved
Development.md Outdated Show resolved Hide resolved
Development.md Outdated Show resolved Hide resolved
Development.md Outdated Show resolved Hide resolved
Development.md Outdated Show resolved Hide resolved
Development.md Outdated Show resolved Hide resolved
Development.md Outdated Show resolved Hide resolved
Copy link
Member

@derberg derberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

left 2 comments

what we are missing additionally is explanation on how to manually test templates features using react-template + you could fix template config in this PR, the version prop

Development.md Show resolved Hide resolved
Development.md Outdated

### Adding tests

1. Create new test files in the appropriate directory under `test/`:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

test is no longer in root

@Gmin2
Copy link
Collaborator Author

Gmin2 commented Sep 16, 2024

I think that for consistency, we should have both either in main readme, or both just mentioned in readme and details in separate markdown files

@lmgyuan and i had a conversation and we both agreed to maake a seperate developement.md, i think we should also add the release process here only.

cc @derberg @lmgyuan

@Gmin2
Copy link
Collaborator Author

Gmin2 commented Sep 16, 2024

you could fix template config in this PR, the version prop

The connfig with the version of different templates right? how do you want the content to be, like pointing to this docs (https://www.asyncapi.com/docs/tools/generator/versioning)

cc @derberg @Florence-Njeri

Copy link
Member

@derberg derberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Gmin2 ok then, please move release process part from readme to development.md

also please update https://github.com/asyncapi/generator/blob/master/apps/generator/test/test-templates/react-template/package.json#L10 so it is apiVersion and not api

Development.md Outdated Show resolved Hide resolved
Development.md Show resolved Hide resolved
Development.md Outdated Show resolved Hide resolved
Development.md Outdated Show resolved Hide resolved
@derberg
Copy link
Member

derberg commented Sep 18, 2024

@Gmin2 you did not move ### Release Flow, it is part of release process section

Copy link

sonarcloud bot commented Sep 18, 2024

@derberg derberg changed the title docs: added the developement guide on how to run test docs: add the development guide on how to run test Sep 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants