[CIVIS-12360] [CIVIS-11015] ENH add CivisFuture.job_run_url property; v2.9.0 release#534
Conversation
Squashed branch work: - ENH CivisFuture.job_run_url property - MAINT update API spec - MAINT GitHub Actions workflow for PyPI releases - MAINT comply with updated license spec for pyproject.toml - MAINT dependabot updates for docs/requirements.txt (incl. suppression) - DOCS refresh docs/requirements.txt - FIX update client.pyi generator for new black formatting - STY black - MAINT update changelog
There was a problem hiding this comment.
Pull request overview
This PR adds a job_run_url property on civis.futures.CivisFuture to expose a run-specific Civis Platform URL, along with a v2.9.0 release bump and maintenance updates (API spec/stubs, docs requirements, and release automation).
Changes:
- Add
CivisFuture.job_run_url(and tests) to generate run-specific job URLs whenrun_idis known. - Update generated API spec artifacts (
client.pyi, generation scripts) and apply formatting cleanups. - Prepare for release: bump version to 2.9.0, add GitHub Actions release workflow, and configure Dependabot suppression for docs.
Reviewed changes
Copilot reviewed 35 out of 37 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| tools/update_civis_api_spec.py | Minor formatting cleanup in the API spec update tool. |
| tests/test_workflows/test_validate.py | Formatting cleanup in tests. |
| tests/test_version.py | Formatting cleanup in tests. |
| tests/test_resources.py | Formatting cleanup in tests. |
| tests/test_parallel.py | Formatting cleanup in tests. |
| tests/test_ml/test_model.py | Formatting cleanup in tests. |
| tests/test_io.py | Formatting cleanup in tests. |
| tests/test_futures.py | Adds assertions for job_run_url behavior. |
| tests/test_client.py | Formatting cleanup in tests. |
| src/civis/workflows/_validate.py | Formatting cleanup. |
| src/civis/workflows/_schemas.py | Formatting cleanup. |
| src/civis/workflows/init.py | Formatting cleanup. |
| src/civis/service_client.py | Formatting cleanup. |
| src/civis/response.py | Formatting cleanup. |
| src/civis/resources/_resources.py | Formatting normalization for frozenset literals. |
| src/civis/resources/_client_pyi.py | Adjusts client.pyi generation formatting (docstrings/deprecation decorator formatting). |
| src/civis/polling.py | Formatting cleanup. |
| src/civis/parallel.py | Formatting cleanup. |
| src/civis/ml/_model.py | Formatting cleanup. |
| src/civis/io/_utils.py | Formatting cleanup. |
| src/civis/io/_tables.py | Minor assignment formatting cleanup. |
| src/civis/io/_files.py | Formatting cleanup. |
| src/civis/io/init.py | Formatting cleanup. |
| src/civis/futures.py | Adds job_run_url property to CivisFuture. |
| src/civis/client.pyi | Regenerated API client stubs reflecting updated API spec and formatting. |
| src/civis/client.py | Formatting cleanup. |
| src/civis/cli/_cli_commands.py | Adds module spacing + formatting cleanup. |
| src/civis/cli/main.py | Formatting cleanup. |
| src/civis/_retries.py | Formatting cleanup. |
| src/civis/_camel_to_snake.py | Formatting cleanup. |
| src/civis/init.py | Formatting cleanup. |
| pyproject.toml | Bumps version to 2.9.0; updates license field format; unpins dev optional dependency versions. |
| docs/requirements.txt | Refreshes pinned docs build dependencies. |
| CHANGELOG.md | Adds 2.9.0 release notes. |
| .github/workflows/release.yml | Adds GitHub Actions workflow to build/publish on GitHub Release publish events. |
| .github/dependabot.yml | Disables Dependabot PRs for /docs dependency updates. |
There was a problem hiding this comment.
I've worked with our IT department to set up the necessary config at PyPI. With this new GitHub Actions workflow, cutting a new GitHub release will build the package for the sdist and wheel, and upload them to PyPI (previously / currently, we did the build and PyPI upload manually).
| from civis.resources._resources import parse_method_name | ||
| from civis._retries import retry_request | ||
|
|
||
|
|
There was a problem hiding this comment.
The updated black formatter has a new take on blank lines, etc.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This pull request adds a new property
job_run_urlatCivisFuture, now that Civis Platform supports script run-specific URLs. I've also wrapped in a few maintenance updates, see the entries inCHANGELOG.md.After this PR is merged, I'll make a v2.9.0 release.
CHANGELOG.mdat the repo's root level