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

chore: render CLI doc messages into their own *.md file in docs #3886

Merged
merged 2 commits into from
Apr 23, 2024

Conversation

jonas-jonas
Copy link
Member

See ory/docs#1722

Related issue(s)

Checklist

  • I have read the contributing guidelines.
  • I have referenced an issue containing the design document if my change
    introduces a new feature.
  • I am following the
    contributing code guidelines.
  • I have read the security policy.
  • I confirm that this pull request does not address a security
    vulnerability. If this pull request addresses a security vulnerability, I
    confirm that I got the approval (please contact
    security@ory.sh) from the maintainers to push
    the changes.
  • I have added tests that prove my fix is effective or that my feature
    works.
  • I have added or changed the documentation.

Further Comments

Copy link

codecov bot commented Apr 19, 2024

Codecov Report

Attention: Patch coverage is 0% with 1 lines in your changes are missing coverage. Please review.

Project coverage is 78.04%. Comparing base (696cc1b) to head (caa5b7e).
Report is 4 commits behind head on master.

❗ Current head caa5b7e differs from pull request most recent head 1643069. Consider uploading reports for the commit 1643069 to get more accurate results

Files Patch % Lines
cmd/clidoc/main.go 0.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #3886      +/-   ##
==========================================
- Coverage   78.05%   78.04%   -0.02%     
==========================================
  Files         360      360              
  Lines       25241    25229      -12     
==========================================
- Hits        19703    19691      -12     
  Misses       4032     4032              
  Partials     1506     1506              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@jonas-jonas jonas-jonas marked this pull request as ready for review April 22, 2024 16:00
@@ -199,7 +199,7 @@ func main() {
}
}

if err := writeMessages(filepath.Join(os.Args[2], "concepts/ui-user-interface.mdx"), sortedMessages); err != nil {
if err := writeMessages(filepath.Join(os.Args[2], "concepts/ui-messages.md"), sortedMessages); err != nil {
Copy link
Member

Choose a reason for hiding this comment

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

This probably needs to be updated in the docs repo then as well? Is there a PR for that already?

Copy link
Member Author

Choose a reason for hiding this comment

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

Already done ory/docs#1722
The tests also check that it works, AFAICT.

@aeneasr aeneasr merged commit 17f9a4f into master Apr 23, 2024
28 checks passed
@aeneasr aeneasr deleted the jonas-jonas/renderCLIDocMessagesIntoOwnFile branch April 23, 2024 09:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants