Update documentation to follow GitHub Actions marketplace best practices

[Copilot]

Pull Request Details

This provides the basic details of the type, related issues, changes made, and changelog for the given pull request.

Description

Aligned all documentation with action.yml and GitHub Actions marketplace standards. Fixed parameter naming inconsistencies, added missing inputs, removed references to non-existent workflows, and corrected example code based on review feedback.

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
• Workflow/CI improvement
• Dependency update

Changes Made

README.md

• Fixed input parameter names: pylint_options → pylint-options, black_options → black-options, mypy_options → mypy-options
• Documented missing inputs: commit-badges, badge-directory
• Added marketplace-standard sections: Prerequisites, Outputs, Permissions, Troubleshooting, How It Works, Best Practices
• Enhanced usage examples with full workflow context and permission declarations
• Added practical examples for common scenarios (multi-version, fork PRs, read-only mode, monorepo)
• Fixed monorepo example: removed misleading working-directory setting and added clarifying comment
• Fixed matrix example: corrected conditional badge commits so only Python 3.11 job commits badges
• Fixed pyproject.toml example: moved max-line-length to correct [tool.pylint.format] section

.github/WORKFLOWS.md

• Removed references to non-existent workflows (test-action.yml, security-audit.yml, dependabot.yml)
• Updated to document only actual workflows: changelog-check.yml, lint-test.yml, release.yml
• Enhanced workflow descriptions with accurate details about yamllint rules and formatting checks

.github/WORKFLOW_QUICK_START.md

• Removed non-existent workflow references from triggers table and troubleshooting
• Updated workflow descriptions to reflect actual functionality

Changelog

• I have updated CHANGELOG.md under the [Unreleased] section
• No changelog update needed (documentation/CI only)

Testing

• All existing tests pass
• I have added tests for my changes (if applicable)
• I have tested the changes locally
• Workflow checks pass

Documentation

• I have updated relevant documentation
• No documentation updates needed

Security

• My changes don't introduce security vulnerabilities
• I have reviewed security scan results
• No security concerns

Checklist

• My code follows the project's style guidelines
• I have performed a self-review of my own code
• I have commented my code where necessary
• My changes generate no new warnings
• Any dependent changes have been merged and published

Additional Notes

Before:

- uses: thoughtparametersllc/python-linting@v1
  with:
    pylint_options: '--max-line-length=120'  # Wrong parameter name

After:

- uses: thoughtparametersllc/python-linting@v1
  with:
    pylint-options: '--max-line-length=120'  # Matches action.yml
    commit-badges: 'true'  # Now documented
    badge-directory: '.github/badges'  # Now documented

Review Feedback Addressed:

• Monorepo example now correctly shows that actions run from repository root
• Matrix build example demonstrates proper conditional badge commits
• Pylint configuration uses correct section structure in pyproject.toml

Original prompt

Update the README.md file and any other documentation file to update the current action.yml and github workflows for it. Follow community best practices for the documentation for github actions published to the GitHub marketplace.

---

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

[thoughtparametersllc]

This should be good enough based on the request.

[Copilot]

Pull request overview

This PR updates documentation to align with action.yml specifications and GitHub Actions marketplace best practices. The changes fix parameter naming inconsistencies (underscore to hyphen), add documentation for previously undocumented inputs (commit-badges, badge-directory), and remove references to non-existent workflows.

Key changes:

• Corrected input parameter names from underscore to hyphen format (e.g., pylint_options → pylint-options)
• Added comprehensive sections including Prerequisites, Outputs, Permissions, Troubleshooting, How It Works, and Best Practices
• Removed all references to non-existent workflows (test-action.yml, security-audit.yml, dependabot.yml)

Reviewed changes

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

File	Description
README.md	Fixed parameter naming, documented missing inputs, added marketplace-standard sections, and expanded usage examples with full workflow context
.github/WORKFLOW_QUICK_START.md	Removed non-existent workflow references from trigger table and troubleshooting sections, updated descriptions to reflect actual workflows
.github/WORKFLOWS.md	Removed documentation for non-existent workflows, updated lint-test.yml description with accurate yamllint rules and formatting checks

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

The example is potentially confusing or incorrect. The defaults.run.working-directory setting only affects run steps, not uses steps (actions). The action will always execute from the repository root, so the requirements-file path is correctly specified as './python-service/requirements.txt'. However, the working-directory setting on lines 322-324 has no effect on the action and may mislead users into thinking it changes the action's working directory. Consider either removing the working-directory setting or adding a clarifying comment that explains the action runs from the repository root and the working-directory only affects shell commands.

[thoughtparametersllc]

@copilot apply changes based on this feedback

[Copilot]

Fixed in commit a689be4. Removed the misleading defaults.run.working-directory setting and added a clarifying comment explaining that the action runs from the repository root regardless of working-directory settings.

[Copilot]

The matrix example sets commit-badges: 'false' with the comment "Only one job should commit badges", but this means no job will commit badges since all matrix jobs have it disabled. Consider clarifying the example by either: (1) showing a separate non-matrix job that commits badges, (2) demonstrating conditional badge commits for only one matrix value (e.g., only when python-version == '3.11'), or (3) explaining that badges should be handled in a separate workflow job when using matrix builds.

Suggested change

	commit-badges: 'false' # Only one job should commit badges
	commit-badges: "${{ matrix.python-version == '3.11' }}" # Only the Python 3.11 job should commit badges