Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions .github/IMPLEMENTATION_SUMMARY.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Python Testing Action - Implementation Summary
# Python Unit Testing Action - Implementation Summary

## Overview

This document provides a comprehensive summary of the Python Testing GitHub Action implementation.
This document provides a comprehensive summary of the Python Unit Testing GitHub Action implementation.

## What Was Built

Expand Down Expand Up @@ -30,7 +30,7 @@ SVG badges can be generated showing:
## File Structure

```
python-testing/
python-unit-testing/
├── action.yml # Main action definition
├── README.md # User-facing documentation
├── CHANGELOG.md # Version history
Expand Down Expand Up @@ -123,19 +123,19 @@ All validations passed successfully:

### Basic Usage
```yaml
- uses: thoughtparametersllc/python-testing@v1
- uses: thoughtparametersllc/python-unit-testing@v1
```

### With Badge Generation
```yaml
- uses: thoughtparametersllc/python-testing@v1
- uses: thoughtparametersllc/python-unit-testing@v1
with:
commit-badges: 'true'
```

### Advanced Configuration
```yaml
- uses: thoughtparametersllc/python-testing@v1
- uses: thoughtparametersllc/python-unit-testing@v1
with:
python-version: '3.11'
requirements-file: 'requirements-dev.txt'
Expand Down Expand Up @@ -185,7 +185,7 @@ Potential improvements for future versions:
## Support

For issues, questions, or contributions:
- GitHub Issues: https://github.com/thoughtparametersllc/python-testing/issues
- GitHub Issues: https://github.com/thoughtparametersllc/python-unit-testing/issues
- Documentation: See README.md and USAGE.md
- Examples: See `.github/workflows/` and `examples/`

Expand Down
10 changes: 5 additions & 5 deletions .github/QUICK_START.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Quick Start Guide

Get started with Python Testing Action in minutes!
Get started with Python Unit Testing Action in minutes!

## 1. Basic Setup (2 minutes)

Expand All @@ -15,7 +15,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: thoughtparametersllc/python-testing@v1
- uses: thoughtparametersllc/python-unit-testing@v1
```

Commit and push. Done! 🎉
Expand All @@ -35,7 +35,7 @@ jobs:
contents: write
steps:
- uses: actions/checkout@v4
- uses: thoughtparametersllc/python-testing@v1
- uses: thoughtparametersllc/python-unit-testing@v1
with:
commit-badges: 'true'
```
Expand All @@ -51,7 +51,7 @@ Then add badge to your README manually:
Add pytest-specific options:

```yaml
- uses: thoughtparametersllc/python-testing@v1
- uses: thoughtparametersllc/python-unit-testing@v1
with:
python-version: '3.11'
requirements-file: 'requirements.txt'
Expand Down Expand Up @@ -79,4 +79,4 @@ Add pytest-specific options:
## Need Help?

- See [Troubleshooting](USAGE.md#troubleshooting) section
- [Open an issue](https://github.com/thoughtparametersllc/python-testing/issues)
- [Open an issue](https://github.com/thoughtparametersllc/python-unit-testing/issues)
26 changes: 13 additions & 13 deletions .github/USAGE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Python Testing Action - Usage Guide
# Python Unit Testing Action - Usage Guide

This guide provides detailed information on using the Python Testing GitHub Action.
This guide provides detailed information on using the Python Unit Testing GitHub Action.

## Table of Contents

Expand All @@ -24,7 +24,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: thoughtparametersllc/python-testing@v1
- uses: thoughtparametersllc/python-unit-testing@v1
```

That's it! The action will install pytest and run your tests.
Expand All @@ -39,7 +39,7 @@ The action installs and runs pytest with your specified options.

**Example configuration:**
```yaml
- uses: thoughtparametersllc/python-testing@v1
- uses: thoughtparametersllc/python-unit-testing@v1
with:
pytest-options: '--cov=mypackage --cov-report=xml'
```
Expand All @@ -51,7 +51,7 @@ The action installs and runs pytest with your specified options.
Specify the Python version to use:

```yaml
- uses: thoughtparametersllc/python-testing@v1
- uses: thoughtparametersllc/python-unit-testing@v1
with:
python-version: '3.11'
```
Expand All @@ -61,7 +61,7 @@ Specify the Python version to use:
Install additional dependencies before running tests:

```yaml
- uses: thoughtparametersllc/python-testing@v1
- uses: thoughtparametersllc/python-unit-testing@v1
with:
requirements-file: 'requirements-dev.txt'
```
Expand All @@ -71,7 +71,7 @@ Install additional dependencies before running tests:
Pass custom options to pytest:

```yaml
- uses: thoughtparametersllc/python-testing@v1
- uses: thoughtparametersllc/python-unit-testing@v1
with:
pytest-options: '--cov --cov-report=xml --maxfail=1'
```
Expand All @@ -92,7 +92,7 @@ jobs:
steps:
- uses: actions/checkout@v4

- uses: thoughtparametersllc/python-testing@v1
- uses: thoughtparametersllc/python-unit-testing@v1
with:
commit-badges: 'true'
badges-directory: '.github/badges'
Expand Down Expand Up @@ -124,7 +124,7 @@ jobs:

steps:
- uses: actions/checkout@v4
- uses: thoughtparametersllc/python-testing@v1
- uses: thoughtparametersllc/python-unit-testing@v1
with:
python-version: ${{ matrix.python-version }}
```
Expand All @@ -145,7 +145,7 @@ jobs:

steps:
- uses: actions/checkout@v4
- uses: thoughtparametersllc/python-testing@v1
- uses: thoughtparametersllc/python-unit-testing@v1
with:
python-version: ${{ matrix.python-version }}
```
Expand All @@ -155,7 +155,7 @@ jobs:
Generate coverage reports with pytest:

```yaml
- uses: thoughtparametersllc/python-testing@v1
- uses: thoughtparametersllc/python-unit-testing@v1
with:
pytest-options: '--cov=mypackage --cov-report=xml --cov-report=html'

Expand All @@ -170,7 +170,7 @@ Generate coverage reports with pytest:
Run different options on different branches:

```yaml
- uses: thoughtparametersllc/python-testing@v1
- uses: thoughtparametersllc/python-unit-testing@v1
with:
pytest-options: ${{ github.ref == 'refs/heads/main' && '--cov --slow' || '--fast' }}
```
Expand Down Expand Up @@ -238,4 +238,4 @@ See the [.github/workflows/](./../workflows/) directory for example workflow con
If you need help:
- Check the [README](../../README.md)
- Review [example workflows](./../workflows/)
- [Open an issue](https://github.com/thoughtparametersllc/python-testing/issues)
- [Open an issue](https://github.com/thoughtparametersllc/python-unit-testing/issues)
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
name: Release and Marketplace

Check warning on line 1 in .github/workflows/release.yml

View workflow job for this annotation

GitHub Actions / Lint YAML Files

1:1 [document-start] missing document start "---"

# This workflow handles automatic semantic versioning, tagging, and GitHub Marketplace submission
# It runs when changes are pushed to main and creates releases based on changelog entries

on:

Check warning on line 6 in .github/workflows/release.yml

View workflow job for this annotation

GitHub Actions / Lint YAML Files

6:1 [truthy] truthy value should be one of [false, true]
push:
branches: [main]
workflow_dispatch:
Expand Down Expand Up @@ -57,7 +57,7 @@
echo "release_notes<<EOF" >> $GITHUB_OUTPUT
echo "$NOTES" >> $GITHUB_OUTPUT
echo "EOF" >> $GITHUB_OUTPUT

Check failure on line 60 in .github/workflows/release.yml

View workflow job for this annotation

GitHub Actions / Lint YAML Files

60:1 [trailing-spaces] trailing spaces
echo "Extracted release notes:"
echo "$NOTES"

Expand All @@ -82,7 +82,7 @@
run: |
# Get the latest semantic version tag
LATEST_TAG=$(git tag -l 'v*.*.*' | sort -V | tail -n 1)

Check failure on line 85 in .github/workflows/release.yml

View workflow job for this annotation

GitHub Actions / Lint YAML Files

85:1 [trailing-spaces] trailing spaces
if [ -z "$LATEST_TAG" ]; then
echo "No previous version tags found, starting with v1.0.0"
echo "latest_tag=v0.0.0" >> $GITHUB_OUTPUT
Expand All @@ -95,32 +95,32 @@
id: determine-version
run: |
LATEST_TAG="${{ steps.get-latest-tag.outputs.latest_tag }}"

Check failure on line 98 in .github/workflows/release.yml

View workflow job for this annotation

GitHub Actions / Lint YAML Files

98:1 [trailing-spaces] trailing spaces
# Remove 'v' prefix for version manipulation
CURRENT_VERSION=${LATEST_TAG#v}

Check failure on line 101 in .github/workflows/release.yml

View workflow job for this annotation

GitHub Actions / Lint YAML Files

101:1 [trailing-spaces] trailing spaces
# Parse version parts
IFS='.' read -r -a VERSION_PARTS <<< "$CURRENT_VERSION"
MAJOR="${VERSION_PARTS[0]:-0}"
MINOR="${VERSION_PARTS[1]:-0}"
PATCH="${VERSION_PARTS[2]:-0}"

Check failure on line 107 in .github/workflows/release.yml

View workflow job for this annotation

GitHub Actions / Lint YAML Files

107:1 [trailing-spaces] trailing spaces
# Determine bump type
if [ "${{ github.event_name }}" == "workflow_dispatch" ]; then
BUMP_TYPE="${{ github.event.inputs.version }}"
else
# Auto-detect from changelog or default to patch
BUMP_TYPE="patch"

Check failure on line 114 in .github/workflows/release.yml

View workflow job for this annotation

GitHub Actions / Lint YAML Files

114:1 [trailing-spaces] trailing spaces
# Check changelog for breaking changes or new features
if grep -A 20 "## \[Unreleased\]" CHANGELOG.md | grep -q "^### Changed" || \
grep -A 20 "## \[Unreleased\]" CHANGELOG.md | grep -q "BREAKING"; then
BUMP_TYPE="minor"
fi
fi

Check failure on line 121 in .github/workflows/release.yml

View workflow job for this annotation

GitHub Actions / Lint YAML Files

121:1 [trailing-spaces] trailing spaces
echo "Bump type: $BUMP_TYPE"

Check failure on line 123 in .github/workflows/release.yml

View workflow job for this annotation

GitHub Actions / Lint YAML Files

123:1 [trailing-spaces] trailing spaces
# Check if BUMP_TYPE is a specific version (e.g., 1.0.0 or v1.0.0)
if [[ "$BUMP_TYPE" =~ ^v?[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
# Strip 'v' prefix if present
Expand Down Expand Up @@ -243,7 +243,7 @@
echo "5. Click 'Update release'"
echo ""
echo "The action.yml already includes marketplace metadata:"
echo " - Name: Python Testing"
echo " - Name: Python Unit Testing"
echo " - Description: Run Python tests using pytest, generate SVG badges for test results, and optionally commit the badges to the repository."
echo " - Author: Jason Miller"
echo " - Branding: check-circle icon, green color"
Expand Down
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Updated USAGE.md to clarify the action installs pytest and runs tests (not automatic detection)
- Updated QUICK_START.md to reflect actual badge generation workflow
- Updated IMPLEMENTATION_SUMMARY.md to accurately reflect pytest-only implementation
- Fixed CONTRIBUTING.md references from "Python Linting Action" to "Python Testing Action"
- Fixed clone path in CONTRIBUTING.md from "python-linting" to "python-testing"
- Fixed CONTRIBUTING.md references from "Python Linting Action" to "Python Unit Testing Action"
- Fixed clone path in CONTRIBUTING.md from "python-linting" to "python-unit-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
Expand Down
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Contributing to Python Testing Action
# Contributing to Python Unit Testing Action

First off, thank you for considering contributing to this project! It's people like you that make the
open-source community such an amazing place to learn, inspire, and create. Any contributions you make are
Expand All @@ -10,8 +10,8 @@ open-source community such an amazing place to learn, inspire, and create. Any c
2. **Clone your fork** locally:

```bash
git clone https://github.com/your-username/python-testing.git
cd python-testing
git clone https://github.com/your-username/python-unit-testing.git
cd python-unit-testing
```

3. **Create a new branch** for your feature or fix:
Expand Down
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# python-testing
# python-unit-testing

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![GitHub Marketplace](https://img.shields.io/badge/Marketplace-Python%20Testing-blue.svg?colorA=24292e&colorB=0366d6&style=flat&longCache=true&logo=github)](https://github.com/marketplace/actions/python-testing)
[![GitHub Marketplace](https://img.shields.io/badge/Marketplace-Python%20Unit%20Testing-blue.svg?colorA=24292e&colorB=0366d6&style=flat&longCache=true&logo=github)](https://github.com/marketplace/actions/python-unit-testing)

GitHub Action to run Python tests using pytest.

Expand Down Expand Up @@ -38,7 +38,7 @@ jobs:
- uses: actions/checkout@v4

- name: Run Python Tests
uses: thoughtparametersllc/python-testing@v1 # or @<commit-sha> before first release
uses: thoughtparametersllc/python-unit-testing@v1 # or @<commit-sha> before first release
```

### Advanced Example with All Options
Expand All @@ -56,7 +56,7 @@ jobs:
- uses: actions/checkout@v4

- name: Run Python Tests
uses: thoughtparametersllc/python-testing@v1
uses: thoughtparametersllc/python-unit-testing@v1
with:
python-version: '3.11'
requirements-file: 'requirements.txt'
Expand All @@ -71,7 +71,7 @@ Enable badge generation to automatically create SVG badges for pytest:

```yaml
- name: Run Python Tests
uses: thoughtparametersllc/python-testing@v1
uses: thoughtparametersllc/python-unit-testing@v1
with:
commit-badges: 'true'
badges-directory: '.github/badges'
Expand Down Expand Up @@ -111,15 +111,15 @@ The action installs pytest and runs your tests with the specified options. You c
### pytest Project with Coverage

```yaml
- uses: thoughtparametersllc/python-testing@v1
- uses: thoughtparametersllc/python-unit-testing@v1
with:
pytest-options: '--cov=mypackage --cov-report=xml'
```

### With Custom Requirements

```yaml
- uses: thoughtparametersllc/python-testing@v1
- uses: thoughtparametersllc/python-unit-testing@v1
with:
requirements-file: 'requirements-dev.txt'
pytest-options: '--verbose'
Expand All @@ -128,7 +128,7 @@ The action installs pytest and runs your tests with the specified options. You c
### With Badge Generation

```yaml
- uses: thoughtparametersllc/python-testing@v1
- uses: thoughtparametersllc/python-unit-testing@v1
with:
pytest-options: '--verbose'
commit-badges: 'true'
Expand Down Expand Up @@ -181,4 +181,4 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
## Support

If you encounter any issues or have questions, please
[open an issue](https://github.com/thoughtparametersllc/python-testing/issues) on GitHub.
[open an issue](https://github.com/thoughtparametersllc/python-unit-testing/issues) on GitHub.
2 changes: 1 addition & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ We take the security of this GitHub Action seriously. If you discover a security
Instead, please report them via email to:

- **Email**: [jason.miller@thoughtparameters.com](mailto:jason.miller@thoughtparameters.com)
- **Subject**: Security Vulnerability in python-testing action
- **Subject**: Security Vulnerability in python-unit-testing action

### What to Include

Expand Down
Loading