Skip to content

docs: add version information to bug template #437

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

Merged
merged 2 commits into from
Mar 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,25 @@ If you are still having issues, please be sure to include as much information as
- pip version: `pip --version`
- `bigframes` version: `pip show bigframes`


```python
import sys
import bigframes
import google.cloud.bigquery
import ibis
import pandas
import pyarrow
import sqlglot

print(f"Python: {sys.version}")
print(f"bigframes=={bigframes.__version__}")
print(f"google-cloud-bigquery=={google.cloud.bigquery.__version__}")
print(f"ibis=={ibis.__version__}")
print(f"pandas=={pandas.__version__}")
print(f"pyarrow=={pyarrow.__version__}")
print(f"sqlglot=={sqlglot.__version__}")
```

#### Steps to reproduce

1. ?
Expand Down
30 changes: 30 additions & 0 deletions owlbot.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@

import pathlib
import re
import textwrap

from synthtool import gcp
import synthtool as s
Expand Down Expand Up @@ -59,6 +60,35 @@
# Fixup files
# ----------------------------------------------------------------------------

# Encourage sharring all relevant versions in bug reports.
s.replace(
[".github/ISSUE_TEMPLATE/bug_report.md"],
re.escape("#### Steps to reproduce\n"),
textwrap.dedent(
"""
```python
import sys
import bigframes
import google.cloud.bigquery
import ibis
import pandas
import pyarrow
import sqlglot

print(f"Python: {sys.version}")
print(f"bigframes=={bigframes.__version__}")
print(f"google-cloud-bigquery=={google.cloud.bigquery.__version__}")
print(f"ibis=={ibis.__version__}")
print(f"pandas=={pandas.__version__}")
print(f"pyarrow=={pyarrow.__version__}")
print(f"sqlglot=={sqlglot.__version__}")
```

#### Steps to reproduce
""",
),
)

# Make sure build includes all necessary files.
s.replace(
["MANIFEST.in"],
Expand Down