-
-
Notifications
You must be signed in to change notification settings - Fork 59
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
feat: display correlationId to the rendered html #135
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide and the instructions about a basic recommended setup useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@M3lkior great first PR! I only made some suggestion to the version of the dummy file we use for development and a suggestion for another script
package.json
Outdated
@@ -22,7 +22,7 @@ | |||
"lint": "echo \"No linter specified yet\"", | |||
"test": "ava", | |||
"release": "semantic-release", | |||
"develop": "ag https://raw.githubusercontent.com/asyncapi/generator/v1.0.0-rc.12/test/docs/dummy.yml ./ -o test/output --force-write --watch-template", | |||
"develop": "ag https://raw.githubusercontent.com/asyncapi/generator/master/test/docs/dummy.yml ./ -o test/output --force-write --watch-template", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"develop": "ag https://raw.githubusercontent.com/asyncapi/generator/master/test/docs/dummy.yml ./ -o test/output --force-write --watch-template", | |
"develop": "ag https://raw.githubusercontent.com/asyncapi/generator/v1.1.5/test/docs/dummy.yml ./ -o test/output --force-write --watch-template", |
there is a certain level of risk that the version on master gets updated and before it is supported by html-template, someone can have issues
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ok, i will change this for the v1.1.5
version
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
README.md
Outdated
@@ -33,6 +33,11 @@ npm install -g @asyncapi/generator | |||
>**NOTE:** If you have to modify the [`dummy.yml`](https://github.com/asyncapi/generator/blob/master/test/docs/dummy.yml) file to develop your features, open a PR with the changes in the [asyncapi/generator](https://github.com/asyncapi/generator) repository. | |||
|
|||
1. Generate output with watcher enabled: `npm run develop`. | |||
|
|||
>**NOTE:** If your changes are not visible, this is maybe because the `ag` use the already installed `html-template` so you should use the `--install` option | |||
> * run `ag https://raw.githubusercontent.com/asyncapi/generator/master/test/docs/dummy.yml ./ -o test/output --install --force-write --watch-template` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
better would be to add a new script for this, like develop:install
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
what about
"//develop:install": "Force ag to install your local html-template source code",
"develop:install": " npm run develop -- --install",
@deberg ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@M3lkior perfect
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i pushed this ; let me know if it is ok for you
d1aeff0
to
26b5021
Compare
@M3lkior all good from my side, you just need to resolve conflicts now |
26b5021
to
28670c6
Compare
it seems ok now ! |
@M3lkior you had conflicts because of this PR https://github.com/asyncapi/html-template/pull/127/files that introduced tailwind v2. Please have a look and adjust the css classes accordingly, so basically no |
28670c6
to
52bf53d
Compare
Oups ^^ it is done |
Kudos, SonarCloud Quality Gate passed! 0 Bugs No Coverage information |
🎉 This PR is included in version 0.17.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
@all-contributors please add @M3lkior for code |
I've put up a pull request to add @M3lkior! 🎉 |
Close #108