効果的な静的解析の CI導入パターンを求めて / Great static analysis with CI

PHP Conference Japan 2020 での発表資料です。
https://phpcon.php.gr.jp/2020/
https://fortee.jp/phpcon-2020/proposal/e0fba818-b475-452d-9bae-b7eb6c80b889

ref.

静的解析の育て方: https://speakerdeck.com/oogfranz/how-to-make-your-static-analysis-strong

Using Feedback Loops to Boost Development Lifecycles: https://www.agileconnection.com/article/using-feedback-loops-boost-development-lifecycles

Psalm: https://psalm.dev/
Phan: https://github.com/phan/phan
PHPStan: https://github.com/phpstan/phpstan

GitHub API: https://docs.github.com/en/free-pro-team@latest/rest/overview/media-types#commits-commit-comparison-and-pull-requests

reviewdog: https://github.com/reviewdog/reviewdog

MASH meets GHIBLI JAZZ: https://youtu.be/ZEtTwGen3fI

Transcript

1. ޮՌతͳ੩తղੳͷ
   CIಋೖύλʔϯΛٻΊͯ
   PHPConference 2020
   αΠϘ΢ζגࣜձࣾɹਿࢁ ༞Ұ
   @oogFranz
   #phpcon #track2
   

   View Slide

2. Whoami
   • ਿࢁ ༞Ұ @oogFranz
   • αΠϘ΢ζ6೥໨ΤϯδχΞ
   • େاۀ޲͚άϧʔϓ΢ΣΞGaroon࡞ͬͯΔ
   • ෳۀδϟζϛϡʔδγϟϯ@MASHݭָஂ
   • ϦϞʔτϫʔΫͷӨڹͰ඘͕ੜ͑ͨ
   
   

   View Slide

3. MASH meets GHIBLI JAZZ
   • https://youtu.be/ZEtTwGen3fI
   • δϒϦۂͷδϓγʔδϟζΞϨϯδCD
   • ੋඇ͓ങ͍ٻΊ͍ͩ͘͞ʂ
   
   

   View Slide

4. αΠϘ΢ζ Garoon ͷද޲͖આ໌
   • େن໛޲͚ͷάϧʔϓ΢ΣΞ
   • ੜ࢈ੑɾνʔϜϫʔΫ޲্ͷࢧԉ
   
   

   View Slide

5. αΠϘ΢ζ Garoon ͷཪଆઆ໌
   • PHPͱMySQLͰͰ͖ͯΔWebΞϓϦέʔγϣϯ
   • ։ൃ19೥໨
   • PHP͸ 4͔Β7.4ʹʢPHP 8.0Ҡߦ΋ਐΊͯͧ͘ʂʣ
   • PHPͷίʔυ͸180ສߦ͘Β͍
   
   

   View Slide

6. αΠϘ΢ζ Garoon ͷཪଆઆ໌
   • PHPͱMySQLͰͰ͖ͯΔWebΞϓϦέʔγϣϯ
   • ։ൃ19೥໨
   • PHP͸ 4͔Β7.4ʹʢPHP 8.0Ҡߦ΋ਐΊͯͧ͘ʂʣ
   • PHPͷίʔυ͸180ສߦ͘Β͍
   
   ͳ͔ͳ͔ϨΨγʔʂ
   

   View Slide

7. ϨΨγʔʹཱͪ޲͔͓͏ʂ
   ϨΨγʔίʔυΛ៉ྷʹͯ͠΍Δʂ
   ·ͣ͸طଘ࣮૷ΛΑ͘ಡΜͰΈΑ͏ʂ
   
   

   View Slide

8. খੴʹͭ·ͣ͘
   ܕએݴ΋ PHPDoc΋ͳͯ͘ίʔυ͕௥͑ͳ͍ɻɻɻ
   Ҿ਺ʹΑͬͯ͸յΕΔϝιου͕͋Δɻɻɻ
   ͜͜ͷίʔυͣͬͱಡΜͰ͚ͨͲɺ
   ͦ΋ͦ΋୭΋ݺͼग़ͯ͠ͳ͍ɻɻɻʁ
   
   

   View Slide

9. খੴʹͭ·ͣ͘
   ܕએݴ΋ PHPDoc΋ͳͯ͘ίʔυ͕௥͑ͳ͍ɻɻɻ
   Ҿ਺ʹΑͬͯ͸յΕΔϝιου͕͋Δɻɻɻ
   ͜͜ͷίʔυͣͬͱಡΜͰ͚ͨͲɺ
   ͦ΋ͦ΋୭΋ݺͼग़ͯ͠ͳ͍ɻɻɻʁ
   
   ຊ࣭తͳ໰୊ʢઃܭͳͲʣʹͨͲΓண͘લʹɺ
   খ͞ͳ໰୊͕ؾʹͳͬͯίʔυϦʔσΟϯά͕ਐ·ͳ͍
   

   View Slide

10. ϨΨγʔʹཱͪ޲͔͏ɺͦͷؒʹ΋
    • ৽͍͠ίʔυ͕ͲΜͲΜ૿͍͑ͯ͘
    • طଘίʔυΛ౿ऻ͞ΕΔͷͰɺ
    ͭ·͖ͮ΍͍͢ίʔυ͕૿͑Δ
    • ϝϯόʔʹΑͬͯεΩϧࠩ΋͋Δ
    
    

    View Slide

11. ϨΨγʔʹཱͪ޲͔͏ɺͦͷؒʹ΋
    • ৽͍͠ίʔυ͕ͲΜͲΜ૿͍͑ͯ͘
    • طଘίʔυΛ౿ऻ͞ΕΔͷͰɺ
    ͭ·͖ͮ΍͍͢ίʔυ͕૿͑Δ
    • ϝϯόʔʹΑͬͯεΩϧࠩ΋͋Δ
    
    খੴ͕૿͑ͳ͍Α͏ʹɺͤΊͯ৽نίʔυ͸៉ྷʹ͍ͨ͠
    

    View Slide

12. খੴΛ·ͣर͏ɾখੴΛ૿΍͞ͳ͍
    • খ͍͞໰୊͕ଟ͍ͱখ͍͞໰୊Ͱؾ͕ࢄΔ
    • খ͍͞໰୊Λ͋Β͔͡ΊݮΒ͢ɾ૿΍͞ͳ͍
    ͜ͱͰΑΓॏେͳ໰୊ʹऔΓ૊Έ΍͘͢ͳΔ
    
    

    View Slide

13. খੴΛ·ͣर͏ɾখੴΛ૿΍͞ͳ͍
    • খ͍͞໰୊͕ଟ͍ͱখ͍͞໰୊Ͱؾ͕ࢄΔ
    • খ͍͞໰୊Λ͋Β͔͡ΊݮΒ͢ɾ૿΍͞ͳ͍
    ͜ͱͰΑΓॏେͳ໰୊ʹऔΓ૊Έ΍͘͢ͳΔ
    ੩తղੳπʔϧΛ$*ʹ૊ΈೖΕΑ͏ʂ
    
    

    View Slide

14. ࠓ೔ͷͬ͘͟Γ࿩
    • ੩తղੳͷ CI ΛΑ͘͢Δ࿩
    • CIࢹ఺த৺
    • ੩తղੳࣗମΛΑ͘͢Δ࿩΋աڈʹ͠·ͨ͠
    
    https://speakerdeck.com/oogfranz/how-to-make-your-static-analysis-strong
    

    View Slide

15. ੩తղੳͱ͸ʁ
    • ίʔυΛ࣮ߦͤͣʹߦ͏ݕূ
    • ͭ·͖ͮͦ͏ͳখੴΛissueͱͯ͠ݟ͚ͭͯ͘ΕΔ
    • όάʹͳΓͦ͏ͳίʔυɺո͍͠ίʔυͷݕ஌
    • ʢ͍͍ͩͨʣૣ͍
    • ʢ͍͍ͩͨʣࣗಈԽ͕͠΍͍͢
    
    

    View Slide

16. ͲΜͳখੴɾissueΛݟ͚ͭͯ͘ΕΔʁ
    • ܕͷෆ੔߹
    • ଘࡏ͠ͳ͍ϝιουͷݺͼग़͠
    • ഑ྻͰͳ͍஋ʢboolean, nullͳͲʣ΁ͷ഑ྻΞΫηε
    • ෆཁίʔυ
    
    

    View Slide

17. 
    ੲͷPHPʹ͋Γ͕ͪɺࣦഊͨ͠Βfalse
    

    View Slide

18. 
    ੲͷPHPʹ͋Γ͕ͪɺࣦഊͨ͠Βfalse
    falseʹͳ͍ͬͯΔͱɺҙਤͤͣ΍ΒΕΔ
    

    View Slide

19. 
    ੲͷPHPʹ͋Γ͕ͪɺࣦഊͨ͠Βfalse
    falseʹͳ͍ͬͯΔͱɺҙਤͤͣ΍ΒΕΔ
    ੩తղੳπʔϧ͕ڭ͑ͯ͘ΕΔʂ
    

    View Slide

20. ςετ͕ͳ͍ϨΨγʔͰ΋
    • ੩తղੳπʔϧ͸ςετίʔυ͕ͳͯ͘΋ಋೖՄೳ
    • ϓϩμΫτʹʢ΄΅ʣΑΒͣɺಋೖՄೳ
    • ϨΨγʔϓϩμΫτ͸ԟʑʹͯ͠ςετίʔυ͕ͳ͍
    • ςετίʔυ͕ͳͯ͘΋όά΍໰୊Λݟ͚ͭΒΕΔ
    
    

    View Slide

21. ςετ͕ͳ͍ϨΨγʔͰ΋
    • ੩తղੳπʔϧ͸ςετίʔυ͕ͳͯ͘΋ಋೖՄೳ
    • ϓϩμΫτʹʢ΄΅ʣΑΒͣɺಋೖՄೳ
    • ϨΨγʔϓϩμΫτ͸ԟʑʹͯ͠ςετίʔυ͕ͳ͍
    • ςετίʔυ͕ͳͯ͘΋όά΍໰୊Λݟ͚ͭΒΕΔ
    
    ੩తղੳπʔϧΛ$*ʹಋೖ͠Α͏ʂ
    

    View Slide

22. Q. CIಋೖ͕ͳͥେࣄ͔ʁ
    
    

    View Slide

23. Q. CIಋೖ͕ͳͥେࣄ͔ʁ
    • શϝϯόʔ͕࠷௿ݶͷΫΥϦςΟͰίʔυΛॻ͚Δ
    • ϑΟʔυόοΫϧʔϓ͕୹͘ͳΔ
    
    

    View Slide

24. ϑΟʔυόοΫϧʔϓͱ͸ʁ
    • ΤϯδχΞɾϓϩμΫτͷԿΒ͔ͷ׆ಈʹɺ
    ϑΟʔυόοΫΛಘͯɺ੡඼ʹ൓ө͢ΔαΠΫϧ
    • e.g.
    • ੡඼ΛϦϦʔεͯ͠ސ٬ͷ൓ԠΛݟΔ
    • ॻ͍ͨίʔυΛϚχϡΞϧςετ͢Δ
    • ίʔυϨϏϡʔΛ͢Δ
    
    

    View Slide

25. ϑΟʔυόοΫϧʔϓͷ֊૚
    IUUQTXXXBHJMFDPOOFDUJPODPNBSUJDMFVTJOHGFFECBDLMPPQTCPPTUEFWFMPQNFOUMJGFDZDMFTΑΓҾ༻
    
    

    View Slide

26. ϑΟʔυόοΫϧʔϓͷ௕͞
    • ϑΟʔυόοΫ͸ૣ͚Ε͹ૣ͍΄Ͳྑ͍
    • ੩తղੳͷCI͸΋ͬͱ΋୹͍ϧʔϓͰ
    ϑΟʔυόοΫΛಘΒΕΔ
    • ίϛοτ୯ҐͰ੩తղੳͷ݁ՌΛϑΟʔυόοΫ͠Α͏
    
    

    View Slide

27. ϑΟʔυόοΫͷ࣭
    • ͙͢ʹϑΟʔυόοΫ͕དྷΔͷͰϑΟʔυόοΫͷ࣭͕େࣄ
    • ཧղɺमਖ਼͸༰қʹ
    • ݟա͝͞Εͳ͍Α͏ʹ
    • ա৒ʹͳΒͳ͍Α͏ʹ
    • Ͱ΋ෆ଍͠ͳ͍Α͏ʹ
    
    

    View Slide

28. ϑΟʔυόοΫͷ࣭
    • ͙͢ʹϑΟʔυόοΫ͕དྷΔͷͰϑΟʔυόοΫͷ࣭͕େࣄ
    • ཧղɺमਖ਼͸༰қʹ
    • ݟա͝͞Εͳ͍Α͏ʹ
    • ա৒ʹͳΒͳ͍Α͏ʹ
    • Ͱ΋ෆ଍͠ͳ͍Α͏ʹ
    
    $*ಋೖ͢Δ͚ͩͰ΋Ғ͍͕ɺ
    ϑΟʔυόοΫΛҙࣝͯ͠ಋೖ͠Α͏ʂ
    

    View Slide

29. ΍ͬͯΈͨ
    

    View Slide

30. Psalm
    • https://psalm.dev/
    • ʢͨͿΜʣαʔϜ /sάːm, sɑ:lm/ ͱൃԻ͢Δ
    • ࢍඒՎɺ੟Վɺࢻฤͱݴ͏ҙຯ
    • vimeo͕։ൃ
    • ઃఆϑΝΠϧ͸XML
    
    

    View Slide

31. ਘৗ͡Όͳ͍issue਺
    
    

    View Slide

32. ਘৗ͡Όͳ͍issue਺
    
    ղੳ݁ՌΛॖখදࣔͨ͠΋ͷʢҰ෦ʣ
    

    View Slide

33. Phan
    • https://github.com/phan/phan
    • ʢͨͿΜʣϑΝϯ(/fan/)ͱൃԻ͢Δ
    • ར༻ʹphp-astͷ֦ு͕ඞཁ
    • ઃఆϑΝΠϧ͸PHPϑΝΠϧ
    • Etsyࣾͷ։ൃ͕ݩ
    
    

    View Slide

34. ਘৗ͡Όͳ͍issue਺
    
    

    View Slide

35. ਘৗ͡Όͳ͍issue਺
    ղੳ݁ՌΛॖখදࣔͨ͠΋ͷʢҰ෦ʣ
    
    

    View Slide

36. ਘৗ͡Όͳ͍issue਺
    • ͦΕ·Ͱ੩తղੳͰอޢ͞Ε͍ͯͳ͍ίʔυ͸
    جຊతʹແ਺ͷissue͕ใࠂ͞ΕΔ
    • ·ͱ΋ʹऔΓ߹͏ͱ৺͕ંΕΔ
    
    

    View Slide

37. ਘৗ͡Όͳ͍issue਺
    • ͦΕ·Ͱ੩తղੳͰอޢ͞Ε͍ͯͳ͍ίʔυ͸
    جຊతʹແ਺ͷissue͕ใࠂ͞ΕΔ
    • ·ͱ΋ʹऔΓ߹͏ͱ৺͕ંΕΔ
    
    େྔͷJTTVFΛ͍ͳͭͭ͠ɺ
    ੩తղੳͷϝϦοτΛಘΔ࢓૊Έ͕ඞཁ
    

    View Slide

38. େྔͷissueʹཱͪ޲͔͏
    • ੩తղੳπʔϧʹ͸ಛఆͷissueΛແࢹ͢Δɺ
    ઃఆʢignore, suppressʣ͕༻ҙ͞Ε͍ͯΔ
    • ͜ΕΛར༻ͯ͠ΈΔ
    
    

    View Slide

39. Psalm
    
    https://psalm.dev/docs/running_psalm/dealing_with_code_issues/#config-suppression
    

    View Slide

40. Psalm
    
    https://psalm.dev/docs/running_psalm/dealing_with_code_issues/#config-suppression
    type="suppress"Ͱ ཈੍
    ϑΝΠϧ΍σΟϨΫτϦͱ͍ͬͨ୯ҐͰࢦఆՄೳ
    

    View Slide

41. Phan
    
    

    View Slide

42. Phan
    
    suppress_issue_typesͰࢦఆ
    

    View Slide

43. PHPStan
    
    

    View Slide

44. PHPStan
    • https://github.com/phpstan/phpstan
    • ݱঢ়ͰҰ൪ਓؾͷ੩తղੳπʔϧ
    • ઃఆϑΝΠϧ͸.neonͱ͍͏yamlͷΑ͏ͳϑΝΠϧ
    • pro൛͕͋ΔʢओʹWeb UIʣ
    
    

    View Slide

45. PHPStan
    
    ΤϥʔϝοηʔδΛਖ਼نදݱͰࢦఆ
    ϑΝΠϧɾσΟϨΫτϦͰର৅Λࢦఆ
    

    View Slide

46. ͻͱ·ͣsuppress
    • ੩తղੳͷCIΛಋೖ͢Δ͜ͱΛ࠷༏ઌ͢ΔͳΒ͋Γ
    • ͙͢ʹ࣏ͤͳ͍ΤϥʔΛ͢΂ͯಥͬࠐΊ͹ɺ
    CIͰΤϥʔʹͳΒͳ͘ͳΔ
    
    

    View Slide

47. suppressͷ໰୊఺
    • suppressͷϧʔϧ͸େຯ͔ɺෳࡶʹͳΔɻ
    • େຯͳઃఆ͸ɺϓϩμΫτશମʹద༻͞ΕΔͨΊɺ
    ৽نͷίʔυͷ੩తղੳ͕ऑ·ͬͯ͠·͏
    • ෳࡶͳϧʔϧ͸ద༻ൣғͷमਖ਼ͳͲ͕ඇৗʹେม
    
    

    View Slide

48. suppressϧʔϧͷϝϯςφϯε
    • suppress͞ΕΔൣғ͸গͳ͍ͨ͘͠
    • suppressͷϧʔϧ͸γϯϓϧʹ͍ͨ͠
    ʢର৅ϑΝΠϧɺσΟϨΫτϦɺͳͲʣ
    
    

    View Slide

49. suppressϧʔϧͷϝϯςφϯε
    • suppress͞ΕΔൣғ͸গͳ͍ͨ͘͠
    • suppressͷϧʔϧ͸γϯϓϧʹ͍ͨ͠
    ʢର৅ϑΝΠϧɺσΟϨΫτϦɺͳͲʣ
    
    ࣗಈͰTVQQSFTTϧʔϧ͕ߋ৽͞ΕΔͱخ͍͠
    

    View Slide

50. suppressϧʔϧͷϝϯςφϯε
    • suppress͞ΕΔൣғ͸গͳ͍ͨ͘͠
    • suppressͷϧʔϧ͸γϯϓϧʹ͍ͨ͠
    ʢର৅ϑΝΠϧɺσΟϨΫτϦɺͳͲʣ
    
    ࣗಈͰTVQQSFTTϧʔϧ͕ߋ৽͞ΕΔͱخ͍͠
    ੩తղੳπʔϧͷCBTFMJOF
    $*πʔϧͷΩϟογϡ
    ͷ૊Έ߹ΘͤͰղܾʂ
    

    View Slide

51. baselineͷಋೖ
    • baseline:
    suppress ruleΛࣗಈੜ੒͢Δػೳ
    • طଘͷissueΛه࿥͠ɺ੩తղੳ࣌ʹ͸
    ه࿥͞ΕͨissueΛແࢹ͢Δ
    •
    
    $ vendor/bin/psalm --save-baseline baseline.xml
    $ vendor/bin/phan --save-baseline baseline.php
    $ vendor/bin/phpstan analyse --generate-baseline phpstan-baseline.neon
    

    View Slide

52. CIͷΩϟογϡ
    • GitHub Actions, CircleCIͱ͍ͬͨCIπʔϧʹ͸
    աڈͷδϣϒ΍ଞͷδϣϒͷσʔλΛΩϟογϡ͠ɺ
    ࠶ར༻͢Δ࢓૊Έ͕͋Δ
    • ΩʔͱϑΝΠϧΛࢦఆͯ͠อଘ
    • ΩʔΛ෦෼Ұகͯ͠औಘͤ͞Δ͜ͱͰɺ
    աڈͷδϣϒͷσʔλΛར༻Ͱ͖Δ
    
    

    View Slide

53. উखʹڧ͘ͳΔ੩తղੳ
    1. ίϛοτͷͨͼʹɺbaselineΛར༻ͯ͠
    ੩తղੳΛ࣮ߦ͢Δ
    2. issue͕ͳ͚Ε͹ɺbaselineΛߋ৽͢Δ
    3. ࣍ͷίϛοτͰ͸৽͍͠baselineΛར༻ͯ͠ɺ
    ੩తղੳΛߦ͏
    
    

    View Slide

54. উखʹڧ͘ͳΔ੩తղੳͷྫ
    • CircleCI + Phan ͷྫ
    • ଞͷCIπʔϧʢGitHub ActionsͳͲʣ΍
    ଞͷ੩తղੳπʔϧʢPHPStan, PsalmͳͲʣͰ΋
    Ԡ༻Մೳʢͷ͸ͣʣ
    
    

    View Slide

55. baselineΛར༻ͯ͠੩తղੳ
    
    phan-load-baseline:
    docker:
    - image: docker-registory.cybozu.private/phan:X.Y.Z
    steps:
    - checkout
    - restore_cache:
    name: Restore baseline
    keys:
    - v1-phan-baseline-{{ .BRANCH }}-
    - v1-phan-baseline-develop-
    - run:
    name: Phan
    command: |
    if [[ -f ~/phan_baseline.php ]]; then
    phan ./ --load-baseline ~/phan_baseline.php
    fi
    

    View Slide

56. baselineΛར༻ͯ͠੩తղੳ
    
    phan-load-baseline:
    docker:
    - image: docker-registory.cybozu.private/phan:X.Y.Z
    steps:
    - checkout
    - restore_cache:
    name: Restore baseline
    keys:
    - v1-phan-baseline-{{ .BRANCH }}-
    - v1-phan-baseline-develop-
    - run:
    name: Phan
    command: |
    if [[ -f ~/phan_baseline.php ]]; then
    phan ./ --load-baseline ~/phan_baseline.php
    fi
    CIʢCircleCIʣͷΩϟογϡ͔Β
    baselineΛऔಘ
    

    View Slide

57. baselineΛར༻ͯ͠੩తղੳ
    
    phan-load-baseline:
    docker:
    - image: docker-registory.cybozu.private/phan:X.Y.Z
    steps:
    - checkout
    - restore_cache:
    name: Restore baseline
    keys:
    - v1-phan-baseline-{{ .BRANCH }}-
    - v1-phan-baseline-develop-
    - run:
    name: Phan
    command: |
    if [[ -f ~/phan_baseline.php ]]; then
    phan ./ --load-baseline ~/phan_baseline.php
    fi
    ։ൃதϒϥϯνʹbaseline͕
    ͋Ε͹ͦΕΛར༻
    

    View Slide

58. baselineΛར༻ͯ͠੩తղੳ
    
    phan-load-baseline:
    docker:
    - image: docker-registory.cybozu.private/phan:X.Y.Z
    steps:
    - checkout
    - restore_cache:
    name: Restore baseline
    keys:
    - v1-phan-baseline-{{ .BRANCH }}-
    - v1-phan-baseline-develop-
    - run:
    name: Phan
    command: |
    if [[ -f ~/phan_baseline.php ]]; then
    phan ./ --load-baseline ~/phan_baseline.php
    fi
    ։ൃதϒϥϯνʹbaseline͕
    ͳ͚Ε͹developϒϥϯνΛར༻
    

    View Slide

59. baselineΛར༻ͯ͠੩తղੳ
    
    phan-load-baseline:
    docker:
    - image: docker-registory.cybozu.private/phan:X.Y.Z
    steps:
    - checkout
    - restore_cache:
    name: Restore baseline
    keys:
    - v1-phan-baseline-{{ .BRANCH }}-
    - v1-phan-baseline-develop-
    - run:
    name: Phan
    command: |
    if [[ -f ~/phan_baseline.php ]]; then
    phan ./ --load-baseline ~/phan_baseline.php
    fi
    ੩తղੳΛ࣮ߦʢ͜͜Ͱ͸Phanʣ
    

    View Slide

60. baselineΛར༻ͯ͠੩తղੳ
    
    phan-load-baseline:
    docker:
    - image: docker-registory.cybozu.private/phan:X.Y.Z
    steps:
    - checkout
    - restore_cache:
    name: Restore baseline
    keys:
    - v1-phan-baseline-{{ .BRANCH }}-
    - v1-phan-baseline-develop-
    - run:
    name: Phan
    command: |
    if [[ -f ~/phan_baseline.php ]]; then
    phan ./ --load-baseline ~/phan_baseline.php
    fi
    baseline͕ݟ͔ͭΒͳ͍࣌͸Skip
    

    View Slide

61. baselineΛར༻ͯ͠੩తղੳ
    
    phan-load-baseline:
    docker:
    - image: docker-registory.cybozu.private/phan:X.Y.Z
    steps:
    - checkout
    - restore_cache:
    name: Restore baseline
    keys:
    - v1-phan-baseline-{{ .BRANCH }}-
    - v1-phan-baseline-develop-
    - run:
    name: Phan
    command: |
    if [[ -f ~/phan_baseline.php ]]; then
    phan ./ --load-baseline ~/phan_baseline.php
    fi
    Ωϟογϡʹอଘ͞Ε͍ͯͨbaselineΛ
    ར༻ͯ͠੩తղੳΛ࣮ߦ
    

    View Slide

62. baselineΛߋ৽͢Δ
    
    phan-save-baseline:
    docker:
    - image: docker-registory.cybozu.private/phan:X.Y.Z
    steps:
    - checkout
    - run:
    name: Save Phan baseline
    command: |
    set +e
    phan ./ --save-baseline ~/phan_baseline.php
    exit 0
    - save_cache:
    key: v1-phan-baseline-{{ .BRANCH }}-{{ .Revision }}
    paths: ~/phan_baseline.php
    

    View Slide

63. phan-save-baseline:
    docker:
    - image: docker-registory.cybozu.private/phan:X.Y.Z
    steps:
    - checkout
    - run:
    name: Save Phan baseline
    command: |
    set +e
    phan ./ --save-baseline ~/phan_baseline.php
    exit 0
    - save_cache:
    key: v1-phan-baseline-{{ .BRANCH }}-{{ .Revision }}
    paths: ~/phan_baseline.php
    baselineΛߋ৽͢Δ
    
    baselineΛ࡞੒
    

    View Slide

64. phan-save-baseline:
    docker:
    - image: docker-registory.cybozu.private/phan:X.Y.Z
    steps:
    - checkout
    - run:
    name: Save Phan baseline
    command: |
    set +e
    phan ./ --save-baseline ~/phan_baseline.php
    exit 0
    - save_cache:
    key: v1-phan-baseline-{{ .BRANCH }}-{{ .Revision }}
    paths: ~/phan_baseline.php
    baselineΛߋ৽͢Δ
    
    ੩తղੳπʔϧʹΑͬͯ͸issue͕ଘࡏ͢Δ
    ͱऴྃίʔυ͕1Λฦ͢ͷͰέΞ͕ඞཁ
    

    View Slide

65. phan-save-baseline:
    docker:
    - image: docker-registory.cybozu.private/phan:X.Y.Z
    steps:
    - checkout
    - run:
    name: Save Phan baseline
    command: |
    set +e
    phan ./ --save-baseline ~/phan_baseline.php
    exit 0
    - save_cache:
    key: v1-phan-baseline-{{ .BRANCH }}-{{ .Revision }}
    paths: ~/phan_baseline.php
    baselineΛߋ৽͢Δ
    
    baselineΛΩϟογϡʹอଘ
    

    View Slide

66. baselineͷϦηοτ
    • ੩తղੳπʔϧͷόʔδϣϯΞοϓͳͲͰ
    baselineΛϦηοτ͍͕ͨ࣌͋͠Δ
    • ΩϟογϡͷΩʔ໊Λมߋ͢Δ
    
    - save_cache:
    key: v1-phan-baseline-{{ .BRANCH }}-{{ .Revision }}
    paths: ~/phan_baseline.php
    - save_cache:
    key: v2-phan-baseline-{{ .BRANCH }}-{{ .Revision }}
    paths: ~/phan_baseline.php
    ΩϟογϡΩʔ໊Λߋ৽͢Δ
    

    View Slide

67. ੩తղੳ͕উखʹڧ͘ͳΔʂ
    

    View Slide

68. ΋ͬͱ੩తղੳΛΑ͍ͨ͘͠ʂ
    

    View Slide

69. • ϑΟʔυόοΫΛվળ͢Δ
    
    ͞ΒʹνʔϜͷ੩తղੳମݧΛΑ͘͢ΔTips
    ཧղ༰қʹ͢Δ
    ϑΟʔυόοΫΛૣ͘͢Δ
    ݎ࿚ʹ͢Δ
    

    View Slide

70. • ϑΟʔυόοΫΛվળ͢Δ
    
    ͞ΒʹνʔϜͷ੩తղੳମݧΛΑ͘͢ΔTips
    ཧղ༰қʹ͢Δ
    ϑΟʔυόοΫΛૣ͘͢Δ
    ݎ࿚ʹ͢Δ
    

    View Slide

71. ੩తղੳʹ͔͔Δ࣌ؒΛ୹͘͢Δ
    • CIͰ஗͍ͱ͜ΖʢϘτϧωοΫʣΛվળ͢Δ
    • ϑΟʔυόοΫϧʔϓ͸ૣ͚Ε͹ૣ͍΄Ͳྑ͍
    • GaroonͰ͸
    • git clone
    • ੩తղੳͷ࣮ߦ
    • ͕஗͔ͬͨ
    

    View Slide

72. git cloneΛૣ͘͢Δ
    • ௕͘։ൃ͍ͯ͠ΔϓϩμΫτͰ͸git clone͕஗͍
    • →shallow cloneΛ͢Δʢ࠷৽ίϛοτ͚ͩऔಘ͢Δʣ
    • Garoonͩͱ໿6ഒૣ͘ͳΔʢ25.2 ඵ → 4.0 ඵʣ
    
    $ git clone --depth=1 --branch ${CIRCLE_BRANCH} \
    --single-branch ${CIRCLE_REPOSITORY_URL}
    

    View Slide

73. ੩తղੳʹ͔͔Δ࣌ؒΛ୹͘͢Δ
    • ࠩ෼ͷ͋ͬͨϑΝΠϧ͚ͩ੩తղੳΛ͔͚Δ
    • →shallow cloneΛ͍ͯ͠Δͱ git diff ͕Ͱ͖ͳ͍
    • ผͷํ๏ͰdiffΛऔಘ͢Δ
    • →GitHub ͷϓϧϦΫऔಘ APIΛ࢖͏
    
    

    View Slide

74. ϓϧϦΫऔಘ GitHub API
    
    $curl -H "Authorization: token ${GITHUB_API_TOKEN}" \
    -H 'Accept: application/vnd.github.v3.diff' \

    https://github.dev.cybozu.co.jp/api/v3/repos/garoon/garoon/pulls/14386
    diff --git a/source/page/master/sample.php b/source/page/master/sample.php
    index b644b6edbf5..03624413a6a 100644
    --- a/source/page/master/sample.php
    +++ b/source/page/master/sample.php
    @@ -1,3 +1,4 @@
    +echo "diff test"
    

    View Slide

75. ϓϧϦΫऔಘ GitHub API
    
    $curl -H "Authorization: token ${GITHUB_API_TOKEN}" \
    -H 'Accept: application/vnd.github.v3.diff' \

    https://github.dev.cybozu.co.jp/api/v3/repos/garoon/garoon/pulls/14386
    diff --git a/source/page/master/sample.php b/source/page/master/sample.php
    index b644b6edbf5..03624413a6a 100644
    --- a/source/page/master/sample.php
    +++ b/source/page/master/sample.php
    @@ -1,3 +1,4 @@
    +echo "diff test"
    media typeͷࢦఆͰdiff͕औΕΔ
    https://docs.github.com/en/free-pro-team@latest/rest/overview/media-types#commits-commit-comparison-and-pull-requests
    

    View Slide

76. 
    $curl -H "Authorization: token ${GITHUB_API_TOKEN}" \
    -H 'Accept: application/vnd.github.v3.diff' \

    https://github.dev.cybozu.co.jp/api/v3/repos/garoon/garoon/pulls/14386
    diff --git a/source/page/master/sample.php b/source/page/master/sample.php
    index b644b6edbf5..03624413a6a 100644
    --- a/source/page/master/sample.php
    +++ b/source/page/master/sample.php
    @@ -1,3 +1,4 @@
    +echo "diff test"
    ࡶʹ +++ ͱϑΝΠϧ֦ுࢠΛgrep͢Ε͹ɺ
    ੩తղੳର৅ͷϑΝΠϧ͕औಘͰ͖Δ
    https://docs.github.com/en/free-pro-team@latest/rest/overview/media-types#commits-commit-comparison-and-pull-requests
    ϓϧϦΫऔಘ GitHub API
    

    View Slide

77. ੩తղੳʹ͔͔Δ࣌ؒΛ୹͘͢Δ
    • Phan͸ͦ΋ͦ΋ಛఆϑΝΠϧͷΈͷ෼ੳ͕Ͱ͖ͳ͍
    • Psalm͸cacheDirectoryΛࢦఆͯ͠ɺ
    ࣮ߦ݁ՌΛΩϟογϡɺ--diff ΦϓγϣϯΛ࢖͏ํ͕ྑͦ͞͏
    • PHPStan΍PHP Code Sniffer (ίʔσΟϯάن໿ͷνΣοΫ
    πʔϧ)Ͱ༗ޮ
    
    

    View Slide

78. • ϑΟʔυόοΫΛվળ͢Δ
    
    ͞ΒʹνʔϜͷ੩తղੳମݧΛΑ͘͢ΔTips
    ཧղ༰қʹ͢Δ
    ϑΟʔυόοΫΛૣ͘͢Δ
    ݎ࿚ʹ͢Δ
    

    View Slide

79. ൃੜͨ͠issueΛΘ͔Γ΍͘͢͢Δ
    • CIʹΤϥʔϝοηʔδΛಡΈʹ͍͘ͷ͸ΊΜͲ͍͘͞
    
    

    View Slide

80. reviewdog
    
    • issueͷग़ͨͱ͜ΖʹࣗಈͰίϝϯτΛ͚ͭͯ͘ΕΔ
    https://github.com/reviewdog/reviewdog
    

    View Slide

81. reviewdog
    
    • issueͷग़ͨͱ͜ΖʹࣗಈͰίϝϯτΛ͚ͭͯ͘ΕΔ
    https://github.com/reviewdog/reviewdog
    GitHub EnterpriseͰ͸API token͕ඞཁ
    APIൃߦऀͷΞΠίϯ͕ग़ΔͷͰ
    νʔϜϝϯόʔ͔ΒݏΘΕ΍͍͢
    

    View Slide

82. botΞΧ΢ϯτ
    • ਓʹ௚઀ౖΒΕΔΑΓ͸ɺbotʹౖΒΕΔํ͕·ͩϚγ
    • botΞΧ΢ϯτΛ࡞ͬͯӡ༻͍ͯ͠Δ
    • GitHubͩͱɺreviewdogͷΞΠίϯ͕ॻ͖ࠐΜͰ͘ΕΔͷͰ҆৺
    

    View Slide

83. • ϑΟʔυόοΫΛվળ͢Δ
    
    ͞ΒʹνʔϜͷ੩తղੳମݧΛΑ͘͢ΔTips
    ཧղ༰қʹ͢Δ
    ϑΟʔυόοΫΛૣ͘͢Δ
    ݎ࿚ʹ͢Δ
    

    View Slide

84. issueΛϝΠϯϒϥϯνʹऔΓࠐ·ͳ͍
    • GitHub ͷ Branch protection rulesΛ͔ͭ͏
    
    

    View Slide

85. issueΛϝΠϯϒϥϯνʹऔΓࠐ·ͳ͍
    • GitHub ͷ Branch protection rulesΛ͔ͭ͏
    
    CIͷνΣοΫΛϚʔδલʹඞਢʹ͢Δ
    

    View Slide

86. issueΛϝΠϯϒϥϯνʹऔΓࠐ·ͳ͍
    • GitHub ͷ Branch protection rulesΛ͔ͭ͏
    
    ඞਢͷCIδϣϒΛબͿ
    

    View Slide

87. issueΛϝΠϯϒϥϯνʹऔΓࠐ·ͳ͍
    • GitHub ͷ Branch protection rulesΛ͔ͭ͏
    
    ඞਢͷCIδϣϒΛબͿ
    

    View Slide

88. issueΛϝΠϯϒϥϯνʹऔΓࠐ·ͳ͍
    • GitHub ͷ Branch protection rulesΛ͔ͭ͏
    
    ඞਢͷCIδϣϒΛબͿ
    $*͕௨Βͳ͍ͱϚʔδͰ͖ͳ͍ʂ
    

    View Slide

89. ·ͱΊ
    • ੩తղੳͷCIಋೖͰϨΨγʔʹཱͪ޲͔͓͏ʂ
    • ϑΟʔυόοΫϧʔϓΛҙࣝͯ͠ɺCIΛಋೖ͠Α͏ʂ
    • baselineͰ੩తղੳͷϝϯςφϯείετΛԼ͛Α͏ʂ
    • খٕΛͨ͘͞Μ࢖ͬͯɺ੩తղੳͷମݧΛΑ͘͠Α͏ʂ
    
    

    View Slide