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.

Sign up for GitHub

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

Jump to bottom

Fix generate-docs Command Sections Parsing #4303

Merged
merged 18 commits into from
Jun 16, 2024
Merged

Fix generate-docs Command Sections Parsing #4303

merged 18 commits into from
Jun 16, 2024

Conversation

kgal-pan
Copy link
Contributor

@kgal-pan kgal-pan commented May 28, 2024 •
edited
Loading

Related Issues

fixes:https://jira-dc.paloaltonetworks.com/browse/CIAC-10635, https://jira-dc.paloaltonetworks.com/browse/XSUP-36639

Description

The PR includes the following changes to the generate-docs command:

  • A fix/improved implementation of finding the commands' sections within the integration README.md which is used when updating modified commands.
  • A new flag, --force, that forces the generation of the new document (instead of updating the existing one based on source control). This allows the user to have more flexibility with usage.
  • Add blocknotes to command README:
image
  • Fix an issue were a modified command name was treated as a new command and appended to the README.

@kgal-pan kgal-pan changed the title Fix gen-docs Command Sections Parsing Fix gen-docs Command Sections Parsing May 28, 2024
@github-actions GitHub Actions
Copy link

Changelog(s) in markdown:

  • Improved implementation of finding the commands' sections within the integration README.md #4303

@kgal-pan kgal-pan changed the title Fix gen-docs Command Sections Parsing Fix generate-docs Command Sections Parsing May 28, 2024
@kgal-pan kgal-pan requested a review from samuelFain as a code owner May 28, 2024 08:51
@kgal-pan kgal-pan requested a review from RotemAmit June 3, 2024 12:45
samuelFain
samuelFain requested changes Jun 4, 2024
View reviewed changes
Copy link
Contributor

@samuelFain samuelFain left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Nice!
@kgal-pan Please review my very few comments :)
Also, it would be much appreciated if you could document these changes in here.

.changelog/4303.yml Outdated Show resolved Hide resolved
demisto_sdk/commands/generate_docs/README.md Show resolved Hide resolved
@kgal-pan kgal-pan requested a review from samuelFain June 4, 2024 13:13
samuelFain
samuelFain approved these changes Jun 16, 2024
View reviewed changes
Copy link
Contributor

@samuelFain samuelFain left a comment

Choose a reason for hiding this comment

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

Nice!

@kgal-pan kgal-pan merged commit 6b02afe into master Jun 16, 2024
27 checks passed
@kgal-pan kgal-pan deleted the CIAC-10635-fix-gen-docs-cmd-end-section branch June 16, 2024 09:24
@content-bot content-bot mentioned this pull request Jun 18, 2024
Merged
@samuelFain samuelFain mentioned this pull request Jun 19, 2024
Merged
This was referenced Jul 29, 2024
Closed
Closed
Closed
Closed
This was referenced Jul 30, 2024
Closed
Closed
Closed
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@samuelFain samuelFain samuelFain approved these changes

@RotemAmit RotemAmit Awaiting requested review from RotemAmit

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@kgal-pan @samuelFain