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: New cmd for docs auto generation #2096

Merged
merged 9 commits into from
Dec 8, 2023

Conversation

islamaliev
Copy link
Contributor

Relevant issue(s)

Resolves #2095

Description

This change adds a new command for generating documents automatically.

It also includes fixes for some overlooked edge cases.

Tasks

  • I made sure the code is well commented, particularly hard-to-understand areas.
  • I made sure the repository-held documentation is changed accordingly.
  • I made sure the pull request title adheres to the conventional commit style (the subset used in the project can be found in tools/configs/chglog/config.yml).
  • I made sure to discuss its limitations such as threats to validity, vulnerability to mistake and misuse, robustness to invalidation of assumptions, resource requirements, ...

How has this been tested?

Unit tests and manual command execution with a running defradb node.

Specify the platform(s) on which this was tested:

  • MacOS

@islamaliev islamaliev added this to the DefraDB v0.9 milestone Dec 1, 2023
@islamaliev islamaliev self-assigned this Dec 1, 2023
@islamaliev islamaliev force-pushed the feat/islam/cmd-for-auto-doc-gen branch from 9c05060 to ce14a55 Compare December 1, 2023 12:38
Copy link

codecov bot commented Dec 1, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (48d0c24) 73.93% compared to head (fd98484) 74.14%.

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff             @@
##           develop    #2096      +/-   ##
===========================================
+ Coverage    73.93%   74.14%   +0.21%     
===========================================
  Files          248      248              
  Lines        24710    24710              
===========================================
+ Hits         18267    18320      +53     
+ Misses        5192     5133      -59     
- Partials      1251     1257       +6     
Flag Coverage Δ
all-tests 74.14% <ø> (+0.21%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

see 9 files with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 48d0c24...fd98484. Read the comment docs.

Copy link
Contributor

@AndrewSisley AndrewSisley left a comment

Choose a reason for hiding this comment

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

Requesting changes super quick before continuing the review as the todo is a major red flag for me and I don't want this merged if approved by someone else whilst I'm still going through it. Will continue the rest of the review now, as the todo doesn't really change anything else already in the review.

Copy link
Contributor

@AndrewSisley AndrewSisley left a comment

Choose a reason for hiding this comment

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

Added a few more comments as I have to context switch, will resume in a little bit.

@fredcarle
Copy link
Collaborator

I don't think we should have this as part of the main Defra CLI but lets discuss it during standup.

@islamaliev islamaliev force-pushed the feat/islam/cmd-for-auto-doc-gen branch 2 times, most recently from bf68130 to 20812dc Compare December 6, 2023 14:52
Copy link
Contributor

@AndrewSisley AndrewSisley left a comment

Choose a reason for hiding this comment

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

Looks really good Islam - thanks for this :)

require.NoError(t, err)
}

func TestGendocsCmd_IfNoErrors_ReturnGenerationOutput(t *testing.T) {
Copy link
Contributor

Choose a reason for hiding this comment

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

praise: These read really nicely, thanks Islam :)

@islamaliev islamaliev force-pushed the feat/islam/cmd-for-auto-doc-gen branch from 20812dc to fd98484 Compare December 8, 2023 08:49
@islamaliev islamaliev merged commit 81fea6e into develop Dec 8, 2023
@islamaliev islamaliev deleted the feat/islam/cmd-for-auto-doc-gen branch December 8, 2023 14:18
shahzadlone pushed a commit to shahzadlone/defradb that referenced this pull request Jan 22, 2024
## Relevant issue(s)

Resolves sourcenetwork#2095

## Description

This change adds a new command for generating documents automatically.

It also includes fixes for some overlooked edge cases.
shahzadlone pushed a commit to shahzadlone/defradb that referenced this pull request Feb 23, 2024
## Relevant issue(s)

Resolves sourcenetwork#2095

## Description

This change adds a new command for generating documents automatically.

It also includes fixes for some overlooked edge cases.
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.

Auto-doc generator: create a cmd for doc generation
4 participants