search

dependabot / dependabot-core

🤖 Dependabot's core logic for creating update PRs.
https://docs.github.com/en/code-security/dependabot
MIT License
4.66k stars 1.01k forks source link

Current changelog truncation is misleading #2274

Closed gschaffner closed 1 year ago

gschaffner commented 4 years ago

Currently, the expandable release notes/changelogs included in Dependabot PRs are sometimes truncated at places that can cause confusion. For example, I have encountered PRs like:

Bumps qutip from 4.4.1 to 4.5.1.

Release notes

Sourced from qutip's releases.

Qutip 4.5.1

Bug Fixes

  • Safer naming for temporary files. (by Eric Giguère)
  • Better error message for failed string coefficient compilation. (issue raised by nohchangsuk)
  • Fix clebsch function for half-integer (by Thomas Walker)
  • Fix randint's dtype to uint32 for compatibility with windows. (issue raised by BoxiLi)
  • Corrected stochastic's heterodyne's m_ops (by eliegenois)
  • Mac pool use spawn. (issue raised by goerz)
  • Fix typos in QobjEvo._shift. (by Eric Giguère)

Improvements

  • Run the python 3.8 test in travis in linux. (by Simon Cross)
  • Moved other tests to 3.8. (by Eric Giguère)
  • Fix travis warning (by Ivan Carvalho)
  • husimi / wigner functions adapted to accept half integer spin. (by maij)

Book keeping

  • Add Boxi Li to authors. (by Alex Pitchford)
  • Deprecate graph function (by Jake Lishman)
  • Skip tests that cause segfault on mac. (by Nathan Shammah and Eric Giguère)

QuTiP 4.5.0

Version 4.5.0 (January 31, 2020) ++++++++++++++++++++++++++++++

Improvements

  • MAJOR FEATURE: Added qip.noise, a module with pulse level description of quantum circuits allowing to model various types of noise and devices (by Boxi Li).

  • MAJOR FEATURE: Added qip.lattice, a module for the study of lattice dynamics in 1D (by Saumya Biswas).

  • Migrated testing from Nose to PyTest (by Tarun Raheja).

  • Optimized testing for PyTest and removed duplicated test runners (by Jake Lishman).

  • Deprecated importing qip functions to the qutip namespace (by Boxi Li).

  • Added the possibility to define non-square superoperators relevant for quantum circuits (by Arne Grimsmo and Josh Combes).

  • Implicit tensor product for qeye, qzero and basis (by Jake Lishman).

  • QObjEvo no longer requires Cython for string coefficient (by Eric Giguère).

  • Added marked tests for faster tests in testing.run() and made faster OpenMP benchmarking in CI (by Eric Giguère).

  • Added entropy and purity for Dicke density matrices, refactored into more general dicke_trace (by Nathan Shammah).

Commits


Dependabot compatibility score

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

If you compare the expandable release notes to qutip's linked release notes, you can see that the expandable notes were truncated in the middle of the release notes for qutip 4.5.0. This can cause confusion and issues if devs aren't aware of this truncation.

Expected behavior, IMO, would be to avoid truncating in the middle of a release's notes. If a truncation has to be made, Dependabot should add a note at the bottom of the expando that a truncation has occurred.

jeffwidman commented 1 year ago

This was implemented sometime in the past, but we forgot to close this issue. See https://github.com/dependabot/dependabot-core/pull/6179 for example where the changelog snippet ends with:

... (truncated)