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

Add a role to collect EOS commands #502

Merged
merged 17 commits into from
Dec 29, 2020
Merged

Add a role to collect EOS commands #502

merged 17 commits into from
Dec 29, 2020

Conversation

ksator
Copy link
Contributor

@ksator ksator commented Dec 16, 2020

Change Summary

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes)
  • Documentation content changes
  • Other (please describe):

Related Issue(s)

Fixes #495

Component(s) name

new role.

Proposed changes

Add a role to collect EOS commands
For each device:

  • It collects the list of show commands
  • It saves each command in a dedicated file
  • It generates a markdown file with all commands output and a table of content

Checklist:

  • I have read the CONTRIBUTING document.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • All new and existing tests passed (pre-commit, make linting and make sanity-lint).
  • I have updated molecule CI testing accordingly

@ksator ksator added the type: enhancement New feature or request label Dec 16, 2020
@ksator ksator self-assigned this Dec 16, 2020
@ksator ksator linked an issue Dec 16, 2020 that may be closed by this pull request
@titom73 titom73 added this to the v1.2.0 milestone Dec 17, 2020
@titom73 titom73 added the state: in-progress Currently work in progress label Dec 17, 2020
@ksator ksator marked this pull request as ready for review December 17, 2020 10:06
@ksator ksator removed the state: in-progress Currently work in progress label Dec 17, 2020
@ksator ksator added help wanted Extra attention is needed and removed help wanted Extra attention is needed labels Dec 20, 2020
@ksator
Copy link
Contributor Author

ksator commented Dec 20, 2020

@titom73 titom73 self-requested a review December 21, 2020 07:32
@github-actions github-actions bot added the type: documentation Improvements or additions to documentation label Dec 22, 2020
@ksator ksator added the help wanted Extra attention is needed label Dec 22, 2020
@titom73
Copy link
Contributor

titom73 commented Dec 22, 2020

If Action fails for Validate mkdoc content, it can be skipped as it is related to PR #528

@ksator
Copy link
Contributor Author

ksator commented Dec 22, 2020

Many thanks. We find out the root cause and fixed it.

@ksator ksator removed the help wanted Extra attention is needed label Dec 22, 2020
@github-actions github-actions bot added the role: build_output_folders issue related to build_output_folders role label Dec 22, 2020
@ksator
Copy link
Contributor Author

ksator commented Dec 22, 2020

Everything is done. Please let me know what I should change (I am at least thinking about changing the role name and dir name.

@ksator
Copy link
Contributor Author

ksator commented Dec 28, 2020

  • rename role to eos_snapshot
  • rename dir to snapshot
  • rename variable to commands_list

Copy link
Contributor

@titom73 titom73 left a comment

Choose a reason for hiding this comment

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

Looks good to me

@titom73 titom73 merged commit ed0929a into aristanetworks:devel Dec 29, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
role: build_output_folders issue related to build_output_folders role state: Documentation role Updated type: documentation Improvements or additions to documentation type: enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

new role to help to collect cli output
2 participants