[
https://issues.apache.org/jira/browse/YETUS-1000?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Allen Wittenauer updated YETUS-1000:
------------------------------------
Release Note:
<!-- markdown -->
Users:
Comments added on a per line basis were only ever shipped with support on
GitHub, only on PRs, and was rarely used due to being very noisy. That
functionality has been removed and replaced with GitHub Checks Annotations when
run under GitHub Actions with support for both branches and PRs. Future/other
changes may re-introduce support for non-GitHub Actions. Any 3rd party plug-ins
that support line-level comments will need to be updated to support the new API.
Developers:
With GitHub Checks Annotations being the preferred way on GitHub for CI systems
to make individual notes, the API requirements and surrounding support
structure for line comments have also changed:
* The unidiff line calculations (`compute_unidiff`) has been removed. This
should greatly increase performance for large patches.
* Relatedly, `GITUNIDIFFLINES` has been removed from the global variables.
* `(bugsystem)_linecoments` and related functions should now expect and pass a
column parameter. Log files should be in typical file:line[:column]:text
format, where the missing column or 0 or "" will be used for no column/whole
file.
* `BUGLINECOMMENTS` is no longer wiped when doing a diff vs. patch.
* `(bugsystem)_linecomments` will no longer receive comments grouped by file
names. Implementers will need to do their own grouping, if required.
* A new `(bugsystem)_linecomments_end` will be called when all line comments
have been processed if there is any final work that needs to be done.
was:
<!-- markdown -->
Users:
Comments added on a per line basis were only ever shipped with support on
GitHub, only on PRs, and was rarely used due to being very noisy. That
functionality has been removed and replaced with GitHub Checks Annotations when
run under GitHub Actions with support for both branches and PRs. Future/other
changes may re-introduce support for non-GitHub Actions. Any 3rd party plug-ins
that support line-level comments will need to be updated to support the new API.
Developers:
With GitHub Checks Annotations being the preferred way on GitHub for CI systems
to make individual notes, the API requirements and surrounding support
structure for line comments have also changed:
* The unidiff line calculations (compute_unidiff) has been removed. This
should greatly increase performance for large patches.
* Relatedly, GITUNIDIFFLINES has been removed from the global variables.
* (bugsystem)_linecoments and related functions should now expect and pass a
column parameter. Log files should be in typical file:line[:column]:text
format, where the missing column or 0 or "" will be used for no column/whole
file.
* BUGLINECOMMENTS is no longer wiped when doing a diff vs. patch.
* (bugsystem)_linecomments will no longer receive comments grouped by file
names. Implementers will need to do their own grouping, if required.
* A new (bugsystem)_linecomments_end will be called when all line comments have
been processed if there is any final work that needs to be done.
> GitHub Actions: use GitHub Checks for line comments support
> -----------------------------------------------------------
>
> Key: YETUS-1000
> URL: https://issues.apache.org/jira/browse/YETUS-1000
> Project: Yetus
> Issue Type: New Feature
> Components: Precommit
> Affects Versions: 0.13.0
> Reporter: Allen Wittenauer
> Assignee: Allen Wittenauer
> Priority: Major
> Fix For: 0.13.0
>
> Time Spent: 20m
> Remaining Estimate: 0h
>
> Replace the github line comments with checks annotations. Doing so will make
> the lack of logging less painful in addition to bringing non-GitHub Actions
> setups more consistent.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
