fix: docs ambiguity - #189
Merged
Merged
Conversation
Bojan Rajh (bojanrajh)
requested review from
Florian Ruppel (fruppel) and
Marcel Kräml (mkraeml)
and
a lite review from Copilot
August 5, 2026 10:41
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates documentation across several actions to remove ambiguity and correct typos, aligning examples and input descriptions more closely with current action behavior.
Changes:
- Documented
github-tokenusage for version-related actions and clarified workflow filename expectations (e.g.,test.yml). - Clarified
upstream-connectbehavior by separating “custom env propagation” from “upstream metadata access via JSON”. - Updated SaaS-related action descriptions and added missing action entry in the repo root README.
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| versions/README.md | Documents the github-token input used for GitHub API release-branch checks. |
| upstream-connect/README.md | Clarifies how upstream metadata is accessed and how custom env is exported. |
| update-saas-refs/README.md | Adjusts description/inputs to match the action’s actual SaaS ref update mechanism. |
| shopware-version/README.md | Renames documented token input to github-token and updates example accordingly. |
| saas-preview-environment/README.md | Updates action description to match supported operations. |
| saas-preview-environment/action.yml | Updates action description to match README/root README wording. |
| README.md | Updates SaaS preview description and adds update-saas-refs to the action list. |
| downstream/README.md | Clarifies that workflow expects a workflow filename (with .yml/.yaml) and updates examples. |
| downstream/action.yml | Fixes typos and clarifies the workflow input description. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Florian Ruppel (fruppel)
approved these changes
Aug 5, 2026
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Soner (shyim)
approved these changes
Aug 5, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR fixes docs and some typos to make the usage more clear.