Repository navigation
Align documentation with action.yml implementation and add marketplace best practices #2
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
Changes from 4 commits
61bfbdd
ec628a8
a487ca1
0a383d1
7635657
771d5ba
fa8d962
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| { | ||
| "default": true, | ||
| "MD013": { | ||
| "line_length": 120, | ||
| "heading_line_length": 120, | ||
| "code_block_line_length": 120, | ||
| "code_blocks": true, | ||
| "tables": false, | ||
| "headings": true, | ||
| "strict": false, | ||
| "stern": false | ||
| }, | ||
| "MD033": { | ||
| "allowed_elements": ["br", "img", "svg", "path", "g", "text", "rect", "linearGradient", "stop", "clipPath"] | ||
| }, | ||
| "MD024": { | ||
| "siblings_only": true | ||
| }, | ||
| "MD041": false, | ||
| "MD046": { | ||
| "style": "fenced" | ||
| } | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,24 +5,39 @@ All notable changes to this project will be documented in this file. | |
| The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), | ||
| and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). | ||
|
|
||
| ## [0.0.1] - 2025-12-19 | ||
| ## [Unreleased] | ||
|
|
||
| ## [1.0.0] - 2025-12-19 | ||
| ### Added | ||
|
|
||
| - SECURITY.md file with security policy and vulnerability reporting guidelines | ||
| - .markdownlint.json configuration file for consistent markdown formatting | ||
| - Comprehensive security best practices documentation | ||
|
|
||
| ### Changed | ||
|
|
||
| - Updated README.md to accurately reflect actual action.yml inputs and functionality | ||
| - Updated USAGE.md to match current pytest-only implementation | ||
| - Updated QUICK_START.md to reflect actual badge generation workflow | ||
| - Fixed CONTRIBUTING.md references from "Python Linting Action" to "Python Testing Action" | ||
| - Fixed clone path in CONTRIBUTING.md from "python-linting" to "python-testing" | ||
| - Removed documentation for non-existent inputs: unittest-options, nose-options, behave-options, | ||
| tox-options, generate-badges, update-readme, readme-path, and badge-style | ||
| - Updated feature list to reflect pytest-only support | ||
| - Simplified framework detection section to reflect current implementation | ||
|
|
||
| ### Fixed | ||
|
|
||
| - Documentation inconsistencies between action.yml and README.md | ||
| - Incorrect action name references in CONTRIBUTING.md | ||
|
|
||
| ## [1.0.1] - 2025-12-19 | ||
|
|
||
| ## [Unreleased] | ||
| Initial release with pytest support | ||
|
||
|
|
||
| ### Added | ||
| ## [1.0.0] - 2025-12-19 | ||
|
|
||
| - Initial release of Python Testing Action | ||
| - Automatic detection of Python testing frameworks | ||
| - Support for pytest with configurable options | ||
| - SVG badge generation for each detected framework | ||
| - Detailed test results in GitHub Actions summary | ||
| - Support for custom requirements file installation | ||
| - Configurable Python version support | ||
| Initial release with pytest support | ||
|
|
||
| ## [1.0.0] - TBD | ||
| ## [0.0.1] - 2025-12-19 | ||
|
|
||
| Initial release | ||
| Initial development release | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@copilot Change this line because this action does't not automatically detect and run your testing frameworks but assumes you have pytest setup in your code in the directory structure.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed in commit 7635657. Changed line 30 from "The action will automatically detect and run your testing frameworks" to "The action will install pytest and run your tests".
Also updated similar misleading language in: