search

phetsims / perennial

Maintenance tools that won't change with different versions of chipper checked out
MIT License
2 stars 5 forks source link

Show all commits + referenced issues between 2 versions #287

Closed samreid closed 1 year ago

samreid commented 1 year ago

For the PhET-iO Project Board, we discussed that it would be nice to be able to see all the commits between 2 versions. This can help us know what we may need to maintenance release, or what QA should test. This is like a "bottom up" dense approach to change logs, which is described in https://github.com/phetsims/tasks/issues/1084

Following https://stackoverflow.com/questions/18679870/list-commits-between-2-commit-hashes-in-git, I checked dependencies.json for gravity and orbits 1.6.0-rc.1 and 1.6.0-rc.4 to see changes in the studio repo

~/apache-document-root/main/studio$ git log --oneline --ancestry-path 7ffb674144cb236e46912eae56a6db6ee5e6b158..da310ee16acc13e7baa958e9ee7c4896fb7c0323
da310ee (HEAD -> master, origin/master, origin/HEAD) grunt update
f2bad6a Add option alertOnVersionUpgrade, see https://github.com/phetsims/studio/issues/281
d686cc1 include assertions in buildStandalone built code, https://github.com/phetsims/phet-io-wrappers/issues/466
599596b remove unneeded phetLibs, https://github.com/phetsims/phet-io-wrappers/issues/466
b48c1ec revert keep track of current studio state to reload to it if available, #259
fcf5777 Revert "better key name, https://github.com/phetsims/studio/issues/259"
b5a9d42 Expand no-simple-type-checking-assertions regex, see: https://github.com/phetsims/mean-share-and-balance/issues/102
3a5d054 Generalize no-simple-type-checking-assertions regex, see https://github.com/phetsims/chipper/issues/1344
164273f ignore locale query parameter when testing standard wrapper in studio, https://github.com/phetsims/studio/issues/278
152099b cursor:pointer on standard wrapper buttons, https://github.com/phetsims/studio/issues/280
b485eac remove todo, https://github.com/phetsims/studio/issues/137
9b41514 better key name, https://github.com/phetsims/studio/issues/259
077e9bd update toString behavior, https://github.com/phetsims/chipper/issues/1338

How would this work if there is branch divergence (no ancestry path from one SHA to the other?)

Anyways, if we had a process that compared package.jsons (possibly from 2 different points in the same repo), it could help us aggregate reports like this.

Tagging @zepumph @arouinfar and @kathy-phet and @jonathanolson since we discussed it together.

Also, I have a little deja vu, did we do this before?

samreid commented 1 year ago

I have a working prototype, but I'm questioning the value of this tool for trunk-based development. Between gravity and orbits 1.6 rc1 and rc4 there were 1490 commits that referenced 208 different issues. Here is that output:

``` Discovered issues https://github.com/phetsims/aqua/issues/150 https://github.com/phetsims/axon/issues/260 https://github.com/phetsims/axon/issues/409 https://github.com/phetsims/axon/issues/418 https://github.com/phetsims/axon/issues/419 https://github.com/phetsims/axon/issues/420 https://github.com/phetsims/axon/issues/420" https://github.com/phetsims/axon/issues/421 https://github.com/phetsims/axon/issues/423 https://github.com/phetsims/axon/issues/424 https://github.com/phetsims/calculus-grapher/issues/78 https://github.com/phetsims/chipper/issues/1277 https://github.com/phetsims/chipper/issues/1323 https://github.com/phetsims/chipper/issues/1325 https://github.com/phetsims/chipper/issues/1331 https://github.com/phetsims/chipper/issues/1335 https://github.com/phetsims/chipper/issues/1337 https://github.com/phetsims/chipper/issues/1338 https://github.com/phetsims/chipper/issues/1339 https://github.com/phetsims/chipper/issues/1341 https://github.com/phetsims/chipper/issues/1342 https://github.com/phetsims/chipper/issues/1343 https://github.com/phetsims/chipper/issues/1344 https://github.com/phetsims/chipper/issues/794 https://github.com/phetsims/energy-skate-park/issues/345 and https://github.com/phetsims/joist/issues/814 https://github.com/phetsims/energy-skate-park/issues/346 https://github.com/phetsims/equality-explorer/issues/192 https://github.com/phetsims/equality-explorer/issues/193 https://github.com/phetsims/equality-explorer/issues/195 https://github.com/phetsims/friction/issues/305 https://github.com/phetsims/friction/issues/312 https://github.com/phetsims/geometric-optics-basics/issues/29 https://github.com/phetsims/gravity-and-orbits/issues/438 https://github.com/phetsims/gravity-and-orbits/issues/439 https://github.com/phetsims/gravity-and-orbits/issues/444 https://github.com/phetsims/gravity-and-orbits/issues/447 https://github.com/phetsims/gravity-and-orbits/issues/448 https://github.com/phetsims/gravity-and-orbits/issues/449 https://github.com/phetsims/gravity-and-orbits/issues/450 https://github.com/phetsims/gravity-and-orbits/issues/451 https://github.com/phetsims/gravity-and-orbits/issues/452 https://github.com/phetsims/gravity-and-orbits/issues/453 https://github.com/phetsims/gravity-and-orbits/issues/454 https://github.com/phetsims/gravity-and-orbits/issues/455 https://github.com/phetsims/gravity-and-orbits/issues/456 https://github.com/phetsims/gravity-and-orbits/issues/457 https://github.com/phetsims/gravity-and-orbits/issues/459 https://github.com/phetsims/gravity-and-orbits/issues/463 https://github.com/phetsims/gravity-and-orbits/issues/465 https://github.com/phetsims/gravity-and-orbits/issues/468 https://github.com/phetsims/gravity-and-orbits/issues/469 https://github.com/phetsims/gravity-and-orbits/issues/470 https://github.com/phetsims/greenhouse-effect/issues/204 https://github.com/phetsims/joist/issues/744 https://github.com/phetsims/joist/issues/814, see https://github.com/phetsims/energy-skate-park/issues/345 https://github.com/phetsims/joist/issues/845 https://github.com/phetsims/joist/issues/846 https://github.com/phetsims/joist/issues/846" https://github.com/phetsims/joist/issues/856 https://github.com/phetsims/joist/issues/858 https://github.com/phetsims/joist/issues/861 https://github.com/phetsims/joist/issues/861 in doc https://github.com/phetsims/joist/issues/864 https://github.com/phetsims/joist/issues/868 https://github.com/phetsims/joist/issues/869 https://github.com/phetsims/joist/issues/870 https://github.com/phetsims/joist/issues/871 https://github.com/phetsims/joist/issues/872 https://github.com/phetsims/joist/issues/873 https://github.com/phetsims/joist/issues/874 https://github.com/phetsims/joist/issues/875 https://github.com/phetsims/joist/issues/876 https://github.com/phetsims/joist/issues/877 https://github.com/phetsims/joist/issues/878 https://github.com/phetsims/mean-share-and-balance/issues/102 https://github.com/phetsims/mean-share-and-balance/issues/115 https://github.com/phetsims/mean-share-and-balance/issues/122 https://github.com/phetsims/molecule-shapes/issues/223 https://github.com/phetsims/molecule-shapes/issues/229 https://github.com/phetsims/molecule-shapes/issues/230 https://github.com/phetsims/number-compare/issues/1 https://github.com/phetsims/perennial/issues/285 https://github.com/phetsims/perennial/issues/286 https://github.com/phetsims/ph-scale/issues/249 https://github.com/phetsims/ph-scale/issues/251 https://github.com/phetsims/ph-scale/issues/252 https://github.com/phetsims/phet-core/issues/124 https://github.com/phetsims/phet-core/issues/125 https://github.com/phetsims/phet-io-sim-specific/issues/10 https://github.com/phetsims/phet-io-sim-specific/issues/12 https://github.com/phetsims/phet-io-sim-specific/issues/13 https://github.com/phetsims/phet-io-sim-specific/issues/14 https://github.com/phetsims/phet-io-sim-specific/issues/15 https://github.com/phetsims/phet-io-sim-specific/issues/3 https://github.com/phetsims/phet-io-sim-specific/issues/6 https://github.com/phetsims/phet-io-wrappers/issues/461 https://github.com/phetsims/phet-io-wrappers/issues/462 https://github.com/phetsims/phet-io-wrappers/issues/464 https://github.com/phetsims/phet-io-wrappers/issues/465 https://github.com/phetsims/phet-io-wrappers/issues/466 https://github.com/phetsims/phet-io-wrappers/issues/469 https://github.com/phetsims/phet-io/issues/1877 https://github.com/phetsims/phet-io/issues/1878 https://github.com/phetsims/phet-io/issues/1882 https://github.com/phetsims/phet-io/issues/1887 https://github.com/phetsims/phet-io/issues/1888 https://github.com/phetsims/phet-io/issues/1890 https://github.com/phetsims/phet-io/issues/1891 https://github.com/phetsims/phet-io/issues/1892 https://github.com/phetsims/phet-io/issues/1893 https://github.com/phetsims/phet-io/issues/1893 https://github.com/phetsims/chipper/issues/1308 https://github.com/phetsims/projectile-motion/issues/289 https://github.com/phetsims/projectile-motion/issues/293 https://github.com/phetsims/projectile-motion/issues/294 https://github.com/phetsims/projectile-motion/issues/295 https://github.com/phetsims/projectile-motion/issues/297 https://github.com/phetsims/projectile-motion/issues/303 https://github.com/phetsims/qa/issues/838 https://github.com/phetsims/qa/issues/846 https://github.com/phetsims/query-string-machine/issues/43 https://github.com/phetsims/ratio-and-proportion/issues/499 https://github.com/phetsims/ratio-and-proportion/issues/499 https://github.com/phetsims/scenery-phet/issues/769 https://github.com/phetsims/ratio-and-proportion/issues/508" https://github.com/phetsims/ratio-and-proportion/issues/509 https://github.com/phetsims/ratio-and-proportion/issues/509 https://github.com/phetsims/joist/issues/293 https://github.com/phetsims/ratio-and-proportion/issues/517 https://github.com/phetsims/ratio-and-proportion/issues/522 https://github.com/phetsims/scenery-phet/issues/439 https://github.com/phetsims/scenery-phet/issues/439 https://github.com/phetsims/scenery-phet/issues/776 https://github.com/phetsims/scenery-phet/issues/692 https://github.com/phetsims/scenery-phet/issues/769 https://github.com/phetsims/scenery-phet/issues/773 https://github.com/phetsims/scenery-phet/issues/777 https://github.com/phetsims/scenery-phet/issues/780 https://github.com/phetsims/scenery-phet/issues/781 https://github.com/phetsims/scenery-phet/issues/782 https://github.com/phetsims/scenery-phet/issues/783 https://github.com/phetsims/scenery-phet/issues/784 https://github.com/phetsims/scenery-phet/issues/785 https://github.com/phetsims/scenery/issues/1418 https://github.com/phetsims/scenery/issues/1419 https://github.com/phetsims/scenery/issues/1445 https://github.com/phetsims/scenery/issues/1445 https://github.com/phetsims/scenery/issues/1483 https://github.com/phetsims/scenery/issues/1446 https://github.com/phetsims/scenery/issues/1451 https://github.com/phetsims/scenery/issues/1455 https://github.com/phetsims/scenery/issues/1460 https://github.com/phetsims/scenery/issues/1461 https://github.com/phetsims/scenery/issues/1462 https://github.com/phetsims/scenery/issues/1464 https://github.com/phetsims/scenery/issues/1466, https://github.com/phetsims/scenery/issues/1419 https://github.com/phetsims/scenery/issues/1467 https://github.com/phetsims/scenery/issues/1468 https://github.com/phetsims/scenery/issues/1471 https://github.com/phetsims/scenery/issues/1472 https://github.com/phetsims/scenery/issues/1473 https://github.com/phetsims/scenery/issues/1474 https://github.com/phetsims/scenery/issues/1476 https://github.com/phetsims/scenery/issues/1477 https://github.com/phetsims/scenery/issues/1480 https://github.com/phetsims/scenery/issues/1481 https://github.com/phetsims/scenery/issues/1481 and https://github.com/phetsims/scenery/issues/1473 https://github.com/phetsims/scenery/issues/1483 https://github.com/phetsims/scenery/issues/1485 https://github.com/phetsims/scenery/issues/1487#event-7667555378 https://github.com/phetsims/scenery/issues/1488 https://github.com/phetsims/scenery/issues/1490 https://github.com/phetsims/scenery/issues/1492 https://github.com/phetsims/scenery/issues/934 https://github.com/phetsims/scenery/issues/942 https://github.com/phetsims/sound/issues/1 https://github.com/phetsims/sound/issues/3 https://github.com/phetsims/sound/issues/6 https://github.com/phetsims/states-of-matter-basics/issues/35 https://github.com/phetsims/studio/issues/137 https://github.com/phetsims/studio/issues/259 https://github.com/phetsims/studio/issues/259" https://github.com/phetsims/studio/issues/278 https://github.com/phetsims/studio/issues/280 https://github.com/phetsims/studio/issues/281 https://github.com/phetsims/sun/issues/706 https://github.com/phetsims/sun/issues/746 https://github.com/phetsims/sun/issues/754 https://github.com/phetsims/sun/issues/772 https://github.com/phetsims/sun/issues/772#issuecomment-1259950764 https://github.com/phetsims/sun/issues/787 https://github.com/phetsims/sun/issues/792 https://github.com/phetsims/sun/issues/793 https://github.com/phetsims/sun/issues/794 https://github.com/phetsims/sun/issues/795 https://github.com/phetsims/sun/issues/798 https://github.com/phetsims/sun/issues/800 https://github.com/phetsims/sun/issues/802 https://github.com/phetsims/sun/issues/804 https://github.com/phetsims/sun/issues/805 https://github.com/phetsims/sun/issues/806 https://github.com/phetsims/tambo/issues/170 https://github.com/phetsims/tandem/issues/263 https://github.com/phetsims/tandem/issues/273 https://github.com/phetsims/tandem/issues/274 https://github.com/phetsims/tandem/issues/277 https://github.com/phetsims/tandem/issues/280 https://github.com/phetsims/utterance-queue/issues/74 https://github.com/phetsims/utterance-queue/issues/74" https://github.com/phetsims/utterance-queue/issues/93 https://github.com/phetsims/vegas/issues/117 https://github.com/phetsims/wave-interference/issues/52 and https://github.com/phetsims/sound/issues/6 https://github.com/phetsims/website/issues/1362 ```
samreid commented 1 year ago

Between gravity and orbits 1.6 rc1 and rc4 there were 1490 commits that referenced 208 different issues

Due to the uncertain helpfulness of this issue, let's close it for now. Next time we want to compare 2 branches we can give it another try if we want. Also caution the script doesn't re-checkout master at the end.