Skip to content
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

Parameter Support #146

Merged
merged 16 commits into from
Jun 1, 2023
Merged

Parameter Support #146

merged 16 commits into from
Jun 1, 2023

Conversation

GrantBirki
Copy link
Member

@GrantBirki GrantBirki commented May 22, 2023

Parameter Support

While investigating #144, it was discovered that the prefix_only option is not working properly. I did a lot of research and testing into this and determined that the path forward is deprecation of this input option for a few reasons:

  1. It is not working as expected
  2. By invoking deployments where .deploy is not the very start of the command will lead to some pretty unexpected behavior
  3. Commands issued in this manner will be hard to read, debug, and can lead to difficult support

I took a look at "why" we would want to use prefix_only in the first place and the overwhelming reason was to try and pass parameters into issueops commands in a fairly "hacky" way. Rather than doing so in a "hacky" way, I determined that the best path forward would be to deprecate prefix_only: false invocations and make parameters a native feature of this Action.

New Inputs

This Pull Request introduces a new Action input and Action output:

  • Input - param_separator - Designates a special character (or string) to separate the IssueOps command from an arbitrary string of parameters
  • Output - params - A raw string of the detected parameters saved to the output of the branch-deploy Action workflow

Further documentation on how parameters work can be found here


Resolves: #144

@GrantBirki GrantBirki added bug Something isn't working enhancement New feature or request labels May 22, 2023
@GrantBirki

This comment was marked as outdated.

@GrantBirki GrantBirki marked this pull request as ready for review June 1, 2023 17:43
@GrantBirki GrantBirki changed the title prefix_only improvements Parameter Support Jun 1, 2023
@GrantBirki GrantBirki merged commit bc8414c into main Jun 1, 2023
4 checks passed
@GrantBirki GrantBirki deleted the prefix_only-improvements branch June 1, 2023 20:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

prefix_only=false is not having any effect
2 participants