Skip to content

Improve version input documentation in README#496

Merged
Legion2 merged 3 commits intomainfrom
copilot/improve-version-input-docs
Dec 21, 2025
Merged

Improve version input documentation in README#496
Legion2 merged 3 commits intomainfrom
copilot/improve-version-input-docs

Conversation

Copy link
Contributor

Copilot AI commented Dec 21, 2025

The version input lacked clear documentation on its purpose and usage, particularly regarding semver range support.

Changes

  • Added dedicated "Version Input" section explaining:

    • Controls which Swagger UI version is used for generation
    • Accepts semver ranges (5.x, ^3.0.0, 5.0.0)
    • Defaults to ^3.0.0
    • Links to npm semver range documentation
  • Updated example workflow to demonstrate version pinning:

- name: Generate Swagger UI
  uses: Legion2/swagger-ui-action@v1
  with:
    output: swagger-ui
    spec-file: openapi.json
    version: 5.x
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
  • Applied prettier formatting for consistency
Original prompt

Improve the documentation of the 'version' input in the README. Specifically:

  • Add a brief section that explains what the 'version' input does, and mention that it accepts semver ranges.
  • Update the example YAML usage in the README to include the 'version' input, e.g.:
    version: 5.x
  • Make sure the new documentation is clear, concise, and follows the structure and style of the rest of the README.

This pull request was created from Copilot chat.


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI and others added 2 commits December 21, 2025 06:34
Co-authored-by: Legion2 <12752323+Legion2@users.noreply.github.com>
Co-authored-by: Legion2 <12752323+Legion2@users.noreply.github.com>
Copilot AI changed the title [WIP] Improve documentation for 'version' input in README Improve version input documentation in README Dec 21, 2025
Copilot AI requested a review from Legion2 December 21, 2025 06:37
@Legion2 Legion2 marked this pull request as ready for review December 21, 2025 17:27
@Legion2 Legion2 merged commit 2fe8d98 into main Dec 21, 2025
2 checks passed
@Legion2 Legion2 deleted the copilot/improve-version-input-docs branch December 21, 2025 17:28
@Legion2 Legion2 mentioned this pull request Dec 21, 2025
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.

2 participants