You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@seata.apache.org by "YongGoose (via GitHub)" <gi...@apache.org> on 2025/04/23 02:12:05 UTC
[I] Improve Spotless Integration: Enhance `CI Workflow` [incubator-seata]
YongGoose opened a new issue, #7308:
URL: https://github.com/apache/incubator-seata/issues/7308
In the last PR, there was a suggestion that our `CI` could be more helpful when code style checks fail.
- https://github.com/apache/incubator-seata/pull/7223#discussion_r2015925979
Currently, the CI fails silently without guiding contributors on how to fix the issue.
To improve the developer experience, I propose two enhancements to the CI workflow:
### 1. Prompt contributors when formatting fails
If code formatting does not meet expectations, the workflow should print a clear message such as:
```
Code style check failed. Please run `mvn spotless:apply` locally to fix formatting issues.
```
This behavior is common in projects like Dubbo and helps reduce confusion for new contributors.
- https://github.com/apache/dubbo/blob/7b34ad9c8640480124c5907de9a76460171921e1/.github/workflows/build-and-test-pr.yml#L63-L67
### 2. Auto-format code and commit to PR
IMHO, It would be great if CI workflow to not only check formatting but also apply fixes via `mvn spotless:apply` and push them directly to the PR.
However, I'm not sure whether this is technically feasible. 😅
If anyone in the community has experience with this or knows more about it, your input would be greatly appreciated.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@seata.apache.org.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@seata.apache.org
For additional commands, e-mail: notifications-help@seata.apache.org
Re: [I] Improve Spotless Integration: Enhance `CI Workflow` [incubator-seata]
Posted by "YongGoose (via GitHub)" <gi...@apache.org>.
YongGoose commented on issue #7308:
URL: https://github.com/apache/incubator-seata/issues/7308#issuecomment-2852554832
**Decision**:
The Spotless team is also aware of this feature, and there's an open issue to implement a way to notify users through comments.
- https://github.com/diffplug/spotless/issues/655
I will implement that feature first, and then apply it to Seata.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@seata.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@seata.apache.org
For additional commands, e-mail: notifications-help@seata.apache.org
Re: [I] Improve Spotless Integration: Enhance `CI Workflow` [incubator-seata]
Posted by "YongGoose (via GitHub)" <gi...@apache.org>.
YongGoose commented on issue #7308:
URL: https://github.com/apache/incubator-seata/issues/7308#issuecomment-2850081411
I plan to proceed with work based on the discussion below.
- https://github.com/diffplug/spotless/discussions
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@seata.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@seata.apache.org
For additional commands, e-mail: notifications-help@seata.apache.org