Skip to content

📖 [Docs]: Remove unused configuration options from README #52

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

Merged
merged 2 commits into from
Jun 2, 2025

Conversation

MariusStorhaug
Copy link
Member

@MariusStorhaug MariusStorhaug commented Jun 2, 2025

Description

This pull request updates the README.md file to simplify the list of configurable settings for the action. It removes several less commonly used settings to streamline the documentation and make it easier to read.

Documentation cleanup:

  • README.md: Removed the following settings from the configuration list: Debug, Verbose, Version, and Prerelease. These settings are no longer included in the documentation to simplify the list and focus on the most relevant options.

Type of change

  • 📖 [Docs]
  • 🪲 [Fix]
  • 🩹 [Patch]
  • ⚠️ [Security fix]
  • 🚀 [Feature]
  • 🌟 [Breaking change]

Checklist

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas

@Copilot Copilot AI review requested due to automatic review settings June 2, 2025 01:16
@MariusStorhaug MariusStorhaug requested a review from a team as a code owner June 2, 2025 01:16
@MariusStorhaug MariusStorhaug self-assigned this Jun 2, 2025
Copy link

@Copilot 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 streamlines the action’s README by removing four less commonly used configuration options, focusing the documentation on the most relevant settings.

  • Removes Debug, Verbose, Version, and Prerelease entries from the configuration table.
  • Simplifies documentation to improve clarity and readability.

@MariusStorhaug MariusStorhaug changed the title 🩹 [Patch]: Remove unused configuration options from README 📖 [Docs]: Remove unused configuration options from README Jun 2, 2025
@MariusStorhaug MariusStorhaug merged commit 2303942 into main Jun 2, 2025
13 checks passed
@MariusStorhaug MariusStorhaug deleted the docs branch June 2, 2025 01:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant