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

bug: Objects missing from GitHub annotations during workflow run #349

Closed
nfelt14 opened this issue Jan 7, 2025 · 3 comments
Closed

bug: Objects missing from GitHub annotations during workflow run #349

nfelt14 opened this issue Jan 7, 2025 · 3 comments
Assignees
Labels
bug Something isn't working

Comments

@nfelt14
Copy link

nfelt14 commented Jan 7, 2025

Description of the bug

When outputting GitHub annotations from the check, the objects are missing from the output. When run with the default format, the changes are correctly picked up

To Reproduce

git clone https://github.com/v12ganesh/tm_devices.git
cd tm_devices
git checkout ganesh12/mso2_fast_acq_support
python scripts/contributor_setup.py
. .venv/bin/activate
pip install -U griffe
griffe check --format=github --against="$(git rev-parse origin/main)" --search=src "tm_devices"

Full traceback

Workflow run: https://github.com/tektronix/tm_devices/actions/runs/12645518273/job/35261966282

Full traceback
Run griffe check --format=github --against="$(git rev-parse origin/main)" --search=src "$PACKAGE_NAME"
  griffe check --format=github --against="$(git rev-parse origin/main)" --search=src "$PACKAGE_NAME"
  shell: /usr/bin/bash -e {0}
  env:
    PACKAGE_NAME: tm_devices
    pythonLocation: /opt/hostedtoolcache/Python/3.1[2](https://github.com/tektronix/tm_devices/actions/runs/12645518273/job/35234789343?pr=368#step:5:2).8/x64
    PKG_CONFIG_PATH: /opt/hostedtoolcache/Python/3.12.8/x64/lib/pkgconfig
    Python_ROOT_DIR: /opt/hostedtoolcache/Python/[3](https://github.com/tektronix/tm_devices/actions/runs/12645518273/job/35234789343?pr=368#step:5:3).12.8/x64
    Python2_ROOT_DIR: /opt/hostedtoolcache/Python/3.12.8/x6[4](https://github.com/tektronix/tm_devices/actions/runs/12645518273/job/35234789343?pr=368#step:5:4)
    Python3_ROOT_DIR: /opt/hostedtoolcache/Python/3.12.8/x[6](https://github.com/tektronix/tm_devices/actions/runs/12645518273/job/35234789343?pr=368#step:5:6)4
    LD_LIBRARY_PATH: /opt/hostedtoolcache/Python/3.12.8/x64/lib
Warning: Public object was removed: `` -> ``
Warning: Public object was removed: `` -> ``
Warning: Public object was removed: `` -> ``
Error: Process completed with exit code 1.

Expected behavior

The objects should be in the annotations.

Environment information

griffe==1.5.4

Additional context

The annotation title has the object, but the annotation contents don't have anything.
image

@nfelt14 nfelt14 added the unconfirmed This bug was not reproduced yet label Jan 7, 2025
@pawamoy
Copy link
Member

pawamoy commented Jan 7, 2025

Thanks for the report @nfelt14. It should simply not output `` -> ``, i.e. something like:

Warning: Public object was removed
Warning: Public object was removed
Warning: Public object was removed

Would that work for you?

@pawamoy pawamoy added bug Something isn't working and removed unconfirmed This bug was not reproduced yet labels Jan 7, 2025
@nfelt14
Copy link
Author

nfelt14 commented Jan 7, 2025

Thanks for the report @nfelt14. It should simply not output -> , i.e. something like:

Warning: Public object was removed
Warning: Public object was removed
Warning: Public object was removed

Would that work for you?

For that warning that seems like it would be fine, since the title has the object name.

@pawamoy
Copy link
Member

pawamoy commented Jan 7, 2025

Exactly, that was the intended format 🙂

pawamoy added a commit that referenced this issue Jan 7, 2025
@pawamoy pawamoy closed this as completed Jan 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants