Skip to content
This repository was archived by the owner on Sep 23, 2025. It is now read-only.

Conversation

@ikostan
Copy link
Member

@ikostan ikostan commented May 18, 2025

Summary by Sourcery

Enhance CI workflows by adding new lint stages, refining CircleCI test steps, updating action versions, and normalizing workflow triggers

CI:

  • Add PyType lint jobs for kyu4 and kyu5 to the GitHub lint pipeline and include them in the dependency chain
  • Update CircleCI config to name the workflow, replace sudo mkdir with mkdir, standardize pytest invocation, generate JUnit XML output, and list test-results directory
  • Upgrade markdownlint-cli2-action to v20 in the Markdown lint workflow
  • Normalize branch filters by removing quotes in kyu2 workflows for MyPy, pydocstyle, and PyLint
  • Introduce workflow_call trigger for the pytest_kyu2 workflow

ikostan and others added 18 commits February 22, 2025 20:58
Merge pull request #662 from iKostanOrg/master
Merge pull request #665 from iKostanOrg/master
Bumps [DavidAnson/markdownlint-cli2-action](https://github.com/davidanson/markdownlint-cli2-action) from 19 to 20.
- [Release notes](https://github.com/davidanson/markdownlint-cli2-action/releases)
- [Commits](DavidAnson/markdownlint-cli2-action@v19...v20)

---
updated-dependencies:
- dependency-name: DavidAnson/markdownlint-cli2-action
  dependency-version: '20'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
…-github/workflows/DavidAnson/markdownlint-cli2-action-20

Bump DavidAnson/markdownlint-cli2-action from 19 to 20 in /.github/workflows
@ikostan ikostan self-assigned this May 18, 2025
@ikostan ikostan added documentation Improvements or additions to documentation codewars code quality Markdown Markdown rules violations kyu_5 labels May 18, 2025
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented May 18, 2025

Reviewer's Guide

This merge updates CI configurations: it adds PyType checks for kyu4 and kyu5 in GitHub Actions, refines CircleCI test steps (including JUnit XML output and streamlined commands), bumps the markdownlint-action version, and standardizes branch definitions and workflow triggers across kyu2 workflows.

Flowchart for Updated CircleCI Test Job Steps

graph TD
    A[Start] --> B["Checkout Code"];
    B --> C["Install Python Packages (pip)"];
    C --> D["Install pytest"];
    D --> E["Show pytest version ('python -m pytest --version')"];
    E --> F["Create 'test-results' folder ('mkdir', was 'sudo mkdir')"];
    F --> G["Run tests with pytest (now includes verbose output and JUnit XML: '. -v --junitxml=test-results/test-results.xml')"];
    G --> H["List test files in 'test-results/' (new step)"];
    H --> I["Store test results from 'test-results/'"];
    I --> J[End];
Loading

File-Level Changes

Change Details Files
Extend GitHub Actions lint/test pipeline with PyType checks for kyu4 and kyu5
  • Added pytype_kyu4 job mirroring existing patterns
  • Added pytype_kyu5 job mirroring existing patterns
  • Included kyu4 and kyu5 in the dependent jobs sequence
.github/workflows/lint_test_build_pipeline.yml
Refine CircleCI test workflow steps for consistency and JUnit reporting
  • Declared workflow name
  • Removed PATH display step
  • Standardized pytest invocation via python -m pytest
  • Created test-results directory without sudo
  • Enabled junit XML output and directory listing
.circleci/config.yml
Bump markdownlint Action to latest version
  • Updated markdownlint-cli2-action from v19 to v20
.github/workflows/markdown_lint.yml
Normalize branch syntax in kyu2 GitHub workflows
  • Removed redundant quotes around branch selectors
.github/workflows/mypy_kyu2.yml
.github/workflows/pydocstyle_kyu2.yml
.github/workflows/pylint_kyu2.yml
Enable reusable workflow trigger in pytest kyu2 workflow
  • Added 'workflow_call' trigger to pytest_kyu2 workflow
.github/workflows/pytest_kyu2.yml

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

@ikostan ikostan merged commit fd45fdd into kyu5 May 18, 2025
25 of 30 checks passed
ikostan added a commit that referenced this pull request May 18, 2025
Merge pull request #669 from iKostanOrg/master
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

code quality codewars documentation Improvements or additions to documentation kyu_5 Markdown Markdown rules violations

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants