Allow specifying tag parameter for setting a custom tag in BSR
#36
Conversation
|
|
There was a problem hiding this comment.
Overall, I think this change is fairly reasonably. It does not support chaining multiple tags, but I think this solves the case for users where they only need to support a single tag, and so it can help unblock many folks already.
Thank you for opening up this change, I left some comments and nits!
| | `buf_token` | The [Buf authentication token][buf-token] used for private [Buf inputs][input] | ✅ | [`${{github.token}}`][github-token] | | ||
| | `input` | The path of the [input] you want to push to BSR as a module | | `.` | | ||
| | `draft` | Indicates if the workflows should push to the BSR as a [draft][buf-draft] | | | | ||
| | `create_visibility` | The visibility to create the BSR repository with, if it does not already exist | | | | ||
| | `tag` | The custom tag to push to the BSR | | | |
There was a problem hiding this comment.
Currently, we don't support "moving"/"re-writing" the same tag to a different commit. So if a user tries to set a single, static tag, their subsequent pushes will fail. This should be called out here.
Suggestion on this documentation:
" A custom tag to push with each commit. The BSR does not currently support moving or duplicated tags, so use this with care."
| VERSION=${GITHUB_SHA} | ||
| if [ -n "${TAG}" ]; then | ||
| VERSION="${TAG}" | ||
| fi |
There was a problem hiding this comment.
I don't think we should have a default behaviour if no tag is set. It should either be "no tag" or "tag with configured value".
| @@ -129,6 +130,26 @@ is not supported by `buf-push-action` on its own - you'll need to stitch this fu | |||
| your workflow on your own. For more details, see [this](https://github.com/bufbuild/buf/issues/838) | |||
| discussion. | |||
|
|
|||
| ### Push with a custom tag | |||
There was a problem hiding this comment.
Currently, you cannot buf push with both a --draft and a --tag. This should be clearly called out in the documentation.
Suggestion: at the end of this section, I would add the following warning:
Important note: you cannot set both `--tag` and `--draft`. You can only use one or the other.
| BUF_ARGS=("--tag" "$VERSION") | ||
| if [ "${DRAFT}" == "true" ]; then |
There was a problem hiding this comment.
We should have a check that does not set both DRAFT and TAG.
|
Just FYI, going to hold off on merging a change like this. I posted an update on the linked issue here: #20 (comment) |
|
Ok, thanks @nicksnyder. Should I close this PR in favor of the upcoming changes? |
|
Yeah, you can close the PR |
Many users (including myself) would benefit from pushing semantic-versioned tags to the Buf Schema Registry for better versioning (for example, in a generated SDK).
This would resolve #20