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

feat: display correlationId to the rendered html #135

Merged
merged 1 commit into from
Feb 1, 2021

Conversation

M3lkior
Copy link
Contributor

@M3lkior M3lkior commented Jan 29, 2021

Close #108

@M3lkior
Copy link
Contributor Author

M3lkior commented Jan 29, 2021

Here is the display for my enterprise project :
image

And the generated based on the dummy.yml 👍
image

image

Copy link

@github-actions github-actions bot left a 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.

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.

@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",
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
"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

Copy link
Contributor Author

@M3lkior M3lkior Feb 1, 2021

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

Copy link
Contributor Author

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`
Copy link
Member

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

Copy link
Contributor Author

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 ?

Copy link
Member

Choose a reason for hiding this comment

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

@M3lkior perfect

Copy link
Contributor Author

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

@M3lkior M3lkior force-pushed the feat/20-display-correlationId branch from d1aeff0 to 26b5021 Compare February 1, 2021 15:47
package.json Show resolved Hide resolved
@derberg
Copy link
Member

derberg commented Feb 1, 2021

@M3lkior all good from my side, you just need to resolve conflicts now

@M3lkior M3lkior force-pushed the feat/20-display-correlationId branch from 26b5021 to 28670c6 Compare February 1, 2021 15:54
@M3lkior
Copy link
Contributor Author

M3lkior commented Feb 1, 2021

@M3lkior all good from my side, you just need to resolve conflicts now

it seems ok now !

@derberg
Copy link
Member

derberg commented Feb 1, 2021

@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 dark or lighter anymore

@M3lkior M3lkior force-pushed the feat/20-display-correlationId branch from 28670c6 to 52bf53d Compare February 1, 2021 16:10
@M3lkior
Copy link
Contributor Author

M3lkior commented Feb 1, 2021

@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 dark or lighter anymore

Oups ^^ it is done

@sonarqubecloud
Copy link

sonarqubecloud bot commented Feb 1, 2021

Kudos, SonarCloud Quality Gate passed!

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@derberg derberg merged commit d77c1c6 into asyncapi:master Feb 1, 2021
@asyncapi-bot
Copy link
Contributor

🎉 This PR is included in version 0.17.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@derberg
Copy link
Member

derberg commented Feb 1, 2021

@all-contributors please add @M3lkior for code

@allcontributors
Copy link
Contributor

@derberg

I've put up a pull request to add @M3lkior! 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Display correlationId in generated doc
3 participants