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

New script to generate the command docs #4664

Merged
merged 15 commits into from
Dec 29, 2024
Merged

New script to generate the command docs #4664

merged 15 commits into from
Dec 29, 2024

Conversation

Shellyber
Copy link
Contributor

@Shellyber Shellyber commented Nov 12, 2024 •
edited
Loading

Related Issues

fixes: https://jira-dc.paloaltonetworks.com/browse/CIAC-12077, https://jira-dc.paloaltonetworks.com/browse/CIAC-12078

Description

  • Script to generate the command description and the options if the command setup has been changed.
  • Pre-commit hook to run the script.

ShahafBenYakir
ShahafBenYakir reviewed Nov 17, 2024
View reviewed changes
Copy link
Contributor

@ShahafBenYakir ShahafBenYakir left a comment

Choose a reason for hiding this comment

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

Nice.

  1. Why did we create two Python files?
  2. I want us to run multiple tests on this i.e make all sorts of changes - delete, add modified etc as creative as you can bee and fix issues.
  3. Do we have infra for unit tests?

demisto_sdk/scripts/generate_commands_docs/pre_commit_generate_docs.py Outdated Show resolved Hide resolved
demisto_sdk/scripts/generate_commands_docs/pre_commit_generate_docs.py Outdated Show resolved Hide resolved
demisto_sdk/scripts/generate_commands_docs/pre_commit_generate_docs.py Outdated Show resolved Hide resolved
demisto_sdk/scripts/generate_commands_docs/pre_commit_generate_docs.py Outdated Show resolved Hide resolved
demisto_sdk/scripts/generate_commands_docs/generate_commands_docs.py Outdated Show resolved Hide resolved
demisto_sdk/scripts/generate_commands_docs/generate_commands_docs.py Outdated Show resolved Hide resolved
demisto_sdk/scripts/generate_commands_docs/generate_commands_docs.py Outdated Show resolved Hide resolved
demisto_sdk/scripts/generate_commands_docs/generate_commands_docs.py Outdated Show resolved Hide resolved
demisto_sdk/scripts/generate_commands_docs/generate_commands_docs.py Outdated Show resolved Hide resolved
demisto_sdk/scripts/generate_commands_docs/generate_commands_docs.py Outdated Show resolved Hide resolved
@github-actions GitHub Actions
Copy link

github-actions bot commented Dec 8, 2024

Changelog(s) in markdown:

  • Added new script and a pre-commit hook to generate commands documentation. #4664

@Shellyber
Copy link
Contributor Author

@ShahafBenYakir Doing some more tests and will add tests for the script. But please review again in the meantime

ShahafBenYakir
ShahafBenYakir approved these changes Dec 26, 2024
View reviewed changes
.changelog/4664.yml Show resolved Hide resolved
@Shellyber Shellyber merged commit 937e16e into master Dec 29, 2024
22 checks passed
@Shellyber Shellyber deleted the generate-commands-docs-script branch December 29, 2024 11:01
This was referenced Dec 29, 2024
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ShahafBenYakir ShahafBenYakir ShahafBenYakir approved these changes

@samuelFain samuelFain Awaiting requested review from samuelFain samuelFain is a code owner

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
@Shellyber @ShahafBenYakir