Reconfigure inputs for actions #37
Conversation
This comment has been minimized.
This comment has been minimized.
Adds a table for the inputs of the action to be more discoverable in the README. In additional some small cleanup, 'disable_symlinks' option has been removed.
Co-authored-by: Nick Snyder <[email protected]>
| # On push github.ref_name, on delete github.event.ref_name. | ||
| archive_labels: ${{ github.ref_name }} | ||
| comment: false | ||
| test-archive-not-exists: |
There was a problem hiding this comment.
Remove this as labels can no longer be given to the action.
There was a problem hiding this comment.
Depending on which merges first, I suppose it would affect #40, but that's okay :)
README.md
Outdated
| | `domain` | Domain for logging into the BSR, enterprise only.| `buf.build` | | ||
| | `input` | [Input](https://buf.build/docs/reference/inputs) for the `buf` command. | | | ||
| | `paths` | Limit to specific files or directories (separated by newlines). | | | ||
| | `exclude_imports` | Exclude imports. | | |
There was a problem hiding this comment.
Exclude imports from what specifically? Needs more explanation
README.md
Outdated
| | `input` | [Input](https://buf.build/docs/reference/inputs) for the `buf` command. | | | ||
| | `paths` | Limit to specific files or directories (separated by newlines). | | | ||
| | `exclude_imports` | Exclude imports. | | | ||
| | `exclude_paths` | Exclude specific files or directories (separated by newlines). | | |
There was a problem hiding this comment.
Exclude paths from what?
Going even further, perhaps neither of these options should exist either, as I think they only apply for lint and breaking (and build?)
There was a problem hiding this comment.
Exclude imports is a requested feature for buf-breaking-action: bufbuild/buf-breaking-action#14
| # On push github.ref_name, on delete github.event.ref_name. | ||
| archive_labels: ${{ github.ref_name }} | ||
| comment: false | ||
| test-archive-not-exists: |
There was a problem hiding this comment.
Depending on which merges first, I suppose it would affect #40, but that's okay :)
It's confusing to not show the check was skipped, this is preferred over not showing the value if the user explicitly disables it via the input parameter.
This PR updates the buf-action from feedback making large changes to the inputs for the action and updating the documentation to reflect those changes. Most users shouldn't see changes in behaviour as the default remain the same. Each commit mentions the affected input values. The following inputs have been changed:
comment: has been replaced bypr_commentdisable_symlinks: removedbreaking_against_config: removedbreaking_limit_to_input_files: removedpush_create: replaced bypush_disable_createwhich defaults to falsepush_create_visibility: removed, always unset with the default ofprivatepush_labels: removed, covered by--git-metadataflagpush_git_metadata: removed, always set by defaultpush_source_control_url: removed, always setarchive_labels: removed, sets the ref by defaultbreaking_againstnow defaults to an empty string and is settable to override. This allows the action to use the declaredinputvalue (as presumably it's a path in the repository) and then configure thebreaking_againstto use that value for thesubdirquery param. This should avoid users having to configure the long expression value themselves.