Skip to content

docs(contributing): Add guide for running CI tests locally with tox-lsr#121

Merged
richm merged 1 commit intolinux-system-roles:mainfrom
liangwen12year:update_docs
Jul 8, 2025
Merged

docs(contributing): Add guide for running CI tests locally with tox-lsr#121
richm merged 1 commit intolinux-system-roles:mainfrom
liangwen12year:update_docs

Conversation

@liangwen12year
Copy link
Copy Markdown
Contributor

@liangwen12year liangwen12year commented Jul 8, 2025

Summary by Sourcery

Add a new section to the contributing guide that explains how to run CI tests locally using tox-lsr with QEMU and provides step-by-step setup instructions

Documentation:

  • Document how to enable EPEL and install the QEMU inventory script for local testing
  • Provide instructions for installing and configuring tox and tox-lsr
  • Explain how to download and use the Linux System Roles config file
  • Show example commands for running QEMU-based test environments via tox

Signed-off-by: Wen Liang <liangwen12year@gmail.com>
@sourcery-ai
Copy link
Copy Markdown

sourcery-ai Bot commented Jul 8, 2025

Reviewer's Guide

This PR enhances the contributing guide by appending a comprehensive “Running CI Tests Locally” section that shows how to use tox-lsr with QEMU, detailing prerequisites, installation steps, configuration, and example commands.

File-Level Changes

Change Details Files
Add guide for running CI tests locally with tox-lsr and QEMU
  • Insert “Running CI Tests Locally” section into contributing.md
  • List steps to enable EPEL repository on RHEL/CentOS
  • Explain how to install standard-test-roles-inventory-qemu (or fallback script)
  • Describe installation of tox and tox-lsr via package manager or pip
  • Provide download step for linux-system-roles config and an example tox command
playbooks/templates/contributing.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Copy Markdown

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

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

Hey @liangwen12year - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@richm richm merged commit 848d627 into linux-system-roles:main Jul 8, 2025
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.

2 participants