-
-
Notifications
You must be signed in to change notification settings - Fork 157
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: update usage documentation for new commands #556
Conversation
…to new-commands-doc
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.
just had a great call with @mhmohona on how this PR can be improved 💪🏼
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.
left two more comments
I think it would make sense to add some note in readme, in development guide section (if we have one, if not, just create) that the given markdown file should not be edited manually as it is generated by the CI
unless we can just generate inside usage.md
file some kind of note about it, a note that will be visible in markdown but not on the website, would have to be between <!-- AUTOGENERATED and info how -->
what do you think?
@mhmohona so what do you thinks about my comment concerning readme or |
@derberg oh, i typed the reply and forgot to click on comment button :3 I was also thinking of writing a blog about on which approach I first wanted to go and later on what happened. |
@mhmohona definitely sounds good but that is a stuff for separate PR for sure |
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.
Awesome work, so let's merge and see what will happen 😄
I will change PR title from feat:
too docs:
as this is not a library relevant change that requires a release of new CLI version.
now, I just noticed we do not have in CLI an automation that would run assets generation without release
please copy to this repo this workflow -> https://github.com/asyncapi/generator/blob/master/.github/workflows/update-docs-on-docs-commits.yml
and I will suggest additional improvements
but basically
# PR should be created within this GH action only if it is a docs: commit
# Otherwise it will conflict with release workflow
if: startsWith(github.event.commits[0].message, 'docs:')
should be moved under:
name: 'Generate docs and create PR'
and
on:
push:
branches:
- master
should be changed to
on:
push:
branches:
- master
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.
LGTM 🚀
let's merge and see if automation works and usage.md will be updated
Kudos, SonarCloud Quality Gate passed! 0 Bugs No Coverage information |
/rtm |
🎉 This PR is included in version 0.45.1 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Description
The script is been added has following workflow -
Related issue(s): Resolves: #123
cc: @derberg