Skip to content

chore: Clean up release workflow and update documentation formatting#165

Merged
Zochory merged 4 commits intomainfrom
bug-fixes
Oct 12, 2025
Merged

chore: Clean up release workflow and update documentation formatting#165
Zochory merged 4 commits intomainfrom
bug-fixes

Conversation

@Zochory
Copy link
Member

@Zochory Zochory commented Oct 12, 2025

Description

Type of Change

  • 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 not work as expected)
  • Documentation update
  • Code refactoring
  • Performance improvement
  • Test updates
  • Configuration change

Related Issues

Fixes #

Changes Made

Testing

  • All existing tests pass (make test)
  • Added new tests for new functionality
  • Configuration validation passes (make test-config)
  • Linting passes (make lint)
  • Formatting is correct (make format)
  • Type checking passes (make type-check)

Test Commands Run

# Commands run to validate changes
make test
make test-config
make lint
make format

Documentation

  • Updated relevant documentation
  • Added docstrings to new functions/classes
  • Updated README if needed
  • Updated CHANGELOG if needed

Screenshots (if applicable)

Checklist

  • My code follows the project's style guidelines
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published

Additional Notes

Copilot AI review requested due to automatic review settings October 12, 2025 14:33
@github-actions github-actions bot added area: config Configuration system type: documentation Improvements or additions to documentation github-actions GitHub Actions workflow changes labels Oct 12, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Oct 12, 2025

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Scanned Files

None

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR performs maintenance tasks to clean up the release workflow and improve documentation formatting consistency. The changes focus on removing an unused GitHub Actions environment configuration and standardizing code block language identifiers in documentation.

  • Removes unnecessary TestPyPI environment configuration from release workflow
  • Standardizes code block formatting in documentation files
  • Improves Markdown heading consistency in README

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

File Description
.github/workflows/release.yml Removes unused TestPyPI environment configuration from the release workflow
docs/WORKFLOWS_QUICK_REFERENCE.md Updates code blocks to use explicit "text" language identifier
docs/GITHUB_ACTIONS_SETUP.md Updates code blocks to use explicit "text" language identifier
README.md Converts bold text headings to proper Markdown headings for better structure

- Updated `ci.yml` to skip configuration tests and pytest coverage on pull requests from forks.
- Modified `release.yml` to use the correct syntax for the `if` condition.
- Added `pytest-cov` to development dependencies in `uv.lock` for improved test coverage reporting.
- Included `coverage` package in `uv.lock` to support coverage reporting.
@github-actions github-actions bot added the dependencies Dependency updates label Oct 12, 2025
@Zochory Zochory merged commit ce8d616 into main Oct 12, 2025
10 of 16 checks passed
@Zochory Zochory deleted the bug-fixes branch October 12, 2025 14:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: config Configuration system dependencies Dependency updates github-actions GitHub Actions workflow changes type: documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants