Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Features
Speaker Deck
PRO
Sign in
Sign up for free
Search
Search
conventional-changelog
Search
kazupon
August 08, 2016
Technology
1
2k
conventional-changelog
kazupon
August 08, 2016
Tweet
Share
More Decks by kazupon
See All by kazupon
わたしのOSS活動
kazupon
3
510
Vapor Revolution
kazupon
3
3.6k
Vue.js最新動向
kazupon
3
1.6k
Vue 3.4
kazupon
13
4.7k
Vue & Vite Rustify
kazupon
4
2.3k
Vue.jsエコシステム動向2023
kazupon
17
7.9k
Reactivity Transform
kazupon
1
1.4k
わたしのOSS活動
kazupon
1
1k
Vue with Vite
kazupon
2
2.6k
Other Decks in Technology
See All in Technology
サービスロボット最前線:ugoが挑むPhysical AI活用
kmatsuiugo
0
180
Understanding Go GC #coefl_go_jp
bengo4com
0
1.1k
Rethinking Incident Response: Context-Aware AI in Practice - Incident Buddy Edition -
rrreeeyyy
0
130
現場が抱える様々な問題は “組織設計上” の問題によって生じていることがある / Team-oriented Organization Design 20250827
mtx2s
1
180
Engineering Failure-Resilient Systems
infraplumber0
0
130
R-SCoRe: Revisiting Scene Coordinate Regression for Robust Large-Scale Visual Localization
takmin
0
400
生成AI利用プログラミング:誰でもプログラムが書けると 世の中どうなる?/opencampus202508
okana2ki
0
190
GCASアップデート(202506-202508)
techniczna
0
240
Goss: New Production-Ready Go Binding for Faiss #coefl_go_jp
bengo4com
0
1.1k
Exadata Database Service on Dedicated Infrastructure セキュリティ、ネットワーク、および管理について
oracle4engineer
PRO
1
360
サイボウズフロントエンドの横断活動から考える AI時代にできること
mugi_uno
4
1.4k
夏休みWebアプリパフォーマンス相談室/web-app-performance-on-radio
hachi_eiji
1
300
Featured
See All Featured
Put a Button on it: Removing Barriers to Going Fast.
kastner
60
4k
Imperfection Machines: The Place of Print at Facebook
scottboms
268
13k
Automating Front-end Workflow
addyosmani
1370
200k
Site-Speed That Sticks
csswizardry
10
780
How to train your dragon (web standard)
notwaldorf
96
6.2k
Navigating Team Friction
lara
188
15k
How GitHub (no longer) Works
holman
315
140k
The Web Performance Landscape in 2024 [PerfNow 2024]
tammyeverts
9
780
Building a Scalable Design System with Sketch
lauravandoore
462
33k
YesSQL, Process and Tooling at Scale
rocio
173
14k
It's Worth the Effort
3n
187
28k
Thoughts on Productivity
jonyablonski
69
4.8k
Transcript
Conventional Changelog ౦ژNodeֶԂ #22 2016-08-08 @kazupon
ࣗݾհ https://github.com/kazupon
ҰԠϝϯόʔͳͷͰࣄ͠ʹ͖·ͨ͠ ͜Ε
ࠓ͢͜ͱ
Conventional Changelog
ຊʹೖΔલʹ
None
changelog (มߋཤྺ) ॻ͍ͯ·͔͢ʁ ຊʹೖΔલʹ
changelog ॻ͔ͳ͍ཧ༝ طʹ Git ͳͲͷόʔδϣϯཧπʔϧͰมߋ༰ͱ͔ ॻ͍ͯ͋Δ͔Βɺgit log GitHub ͱ͔ͰάϥϑΟΧ
ϧͳͷͰݟΕΔ͔Βɺॻ͔ͳ͍͍ͯ͘Ͱ͠ΐ
changelog ॻ͔ͳ͍ཧ༝ MS WordɺGoogle docs ͳͲͷผͳυΩϡϝϯτͰ ͲͬͪΈͪॻ͔͘Βɺಉ͡Α͏ͳ͜ͱͨ͘͠ͳ͍
ͦͦॻ͘ͷ͕ΊΜͲ͍ʂ ॻ͔ͳ͍࠷େཧ༝
झຯɺϓϩτλΠϓతͳ ͷͳΒɺ·͍͍͋ͱͯ͠
ଞͷਓʹΘΕΔιϑτΣΞ Λ։ൃͯ͠ఏڙ͍ͯ͠Δͷʹɺ ΊΜͲ͍ͬͯݴͬͯΔͷ
None
changelog ඞཁͩ มߋ࣌ มߋऀ ରόʔδϣϯ มߋ༰ ιϑτΣΞͷมߋ༰Λ࣌ܥྻͰ ֓ཁΛѲ͢Δͷʹ༰қ
changelog ͍ΖΜͳਓ͕ಡΉ WebαʔϏεɺΞϓϦɺ ۀγεςϜͳͲͷιϑ τΣΞ։ൃ͍ͯ͠ΔΤ ϯδχΞ σβΠφʔ͞ΜͷΑ͏ͳ ։ൃʹܞΘ͍ͬͯΔ non- tech
ͳਓ ҰମԿ͕มߋ͞ΕͨΜͩΖ͏ʁ ͨͯ͠ΞοϓάϨʔυ͢Δඞཁ͕͋Δ ͷͩΖ͏͔ʁ
͜ΕΛػʹॻ͍͍ͯͳ͔ͬͨਓ ɺchangelog ॻ͖·͠ΐ͏ʂ
͋͋ɺchangelog ͕େࣄͳͷ ͔ͬͨ
ͰɺGit Ͱ͏طʹมߋ༰ ͱ͔ॻ͍ͯ͋Δͷʹɺ ಉ͡Α͏ͳ͜ͱͨ͘͠ͳ͍ͳ͋
ͳΜ͔ɺָʹ changelog ॻ ͚ΔΑ͏ʹɺΑ͠ͳʹͬ ͯ͘ΕΔͷͳ͍ͷʁ
ͱࢥ͏ਓ͕͍Δͱࢥ͍·͢
ͦ͜Ͱ͜Ε͕ग़൪Ͱ͢Αʂ
Conventional Changelog ͱ changelog ͷͨΊͷίϛοτϝοηʔδن CLI πʔϧίϛοτϝοηʔδنΛݩʹ changelog ΛੜͰ͖ΔΈΛఏڙ
Conventional Changelog ಈ࡞Πϝʔδ ίϛοτϩά changelog ϑΝΠϧ ίϛοτϝοηʔδن ϑΝΠϧ CLI ࣗಈੜ
!!
ੜ͞Εͨ changelog ͷத ίϛοτϋογϡ͔Β GitHubͷURLΛඥ͚ͯ͘ΕΔ มߋ༰ΛάϧʔϓԽͱ͔ ͯ͘͠ΕͨΓ͢Δ ྫ: karma ͷ
CHANGELOG.md
جຊతͳ։ൃ࡞ۀͷྲྀΕ (͍ํ)
1. ։ൃ࡞ۀ ࣮ or मਖ਼ ςετ
2. Git Ͱίϛοτ ։ൃ࡞ۀͰมߋͨ͠ͷΛίϛοτ
3. package.json ͷόʔδϣϯΛ্͛Δ όʔδϣϯΛมߋ
4. CLI πʔϧΛ࣮ߦ $ conventional-changelog -i CHANGELOG.md -s -p angular
5. changelog ϑΝΠϧͱ package.json Λίϛοτ front-endͷΑ͏ͳϏϧυͨ͠ͷඞཁͳΒͦΕί ϛοτ
6. Git Ͱλά͚ git tag ͰόʔδϣϯΛλά͚
7. ϦϦʔε git push ͰϦϙδτϦʹΞοϓϩʔυ ඞཁʹԠͯ͡ npm publish
ಋೖ͢Δࡍͷҙ ιʔεͰ͋Δ Git ίϛοτϩά͕μϝͩͱɺੜ͞ ΕΔ changelog μϝͳͷ͕ੜ͞ΕΔ ίϛοτϝοηʔδنʹैͬͯɺྑ͍ίϛοτϝο ηʔδΛॻ͘͜ͱ͕ॏཁ
ίϛοτϝοηʔδن ϓϦηοτ angular https://github.com/conventional-changelog/conventional-changelog-angular jquery https://github.com/conventional-changelog/conventional-changelog-jquery ember https://github.com/conventional-changelog/conventional-changelog-ember express https://github.com/conventional-changelog/conventional-changelog-express
ίϛοτϝοηʔδن ϓϦηοτ jshint https://github.com/conventional-changelog/conventional-changelog-jshint eslint https://github.com/conventional-changelog/conventional-changelog-eslint code mirror https://github.com/conventional-changelog/conventional-changelog-codemirror atom
https://github.com/conventional-changelog/conventional-changelog-atom
❤͓קΊϓϦηοτ ❤
ಠࣗίϛοτϝοηʔδ نͷఆٛ ͪΖΜࣗͰίϛοτϝοηʔδنΛఆٛ͢Δ ͜ͱ͕Ͱ͖Δ ΦϨΦϨ ίϛοτϝοηʔδن
Angular ͷίϛοτϝοηʔδنΛ֦ு ͯ͠ emoji ʹରԠͨ͠ྫ https://github.com/kazupon/git-commit-message-convention
ಠࣗίϛοτϝοηʔδͷఆٛ(֦ு)
JSͰΧελϜϝοηʔδنΛ࣮ changelog ʹ ॻ͖ࠐΉࡍͷ άϧʔϓมઃఆ ίϛοτϝοηʔδ ͔Βநग़͢Δύλʔϯઃఆ
ੜ͞Εͨ changelog emoji ίʔυ͕ೖͬͨάϧʔϐϯά ಠࣗʹఆٛͨ͠άϧʔϓ ಠࣗʹఆٛͨ͠ notekeywords
emoji ೖΓͰมߋཤྺ͕දࣔ
ςϯϓϨʔτͷΧελϚΠζ handlebars ه๏ ͰΧελϚΠζͰ͖Δ ϑΝΠϧ جຊ markdown ܗࣜ
ςϯϓϨʔτͷߏ جຊ template.hbs ʹҎԼͷΑ͏ʹ ߏԽ͞Ε͍ͯΔ - header - commitGroups -
commits - commit - footer (͋Ε) ڽͬͨςϯϓϨʔτͷΧελϚΠζΛ͍ͨ͠߹ɺ ఏڙ͞Ε͍ͯΔίϛοτϝοηʔδنͷ֤ϓϦηο τͷ templates σΟϨΫτϦΛࢀߟʹ͢ΔͱΑ͍
Angular ίϛοτϝοηʔδنͷ ςϯϓϨʔτ https://github.com/conventional-changelog/conventional-changelog-angular/tree/master/templates
GitHub Release Integration conventional-github-releaser Ͱ GitHub Release ͱ࿈ ܞ͢Δ͜ͱՄೳ $
conventional-github-releaser -p angular -r 0
API Conventional Changelog Ͱఏڙ͍ͯ͠Δ CLI πʔϧ Ͱຬग़དྷͳ͍߹ɺఏڙ͍ͯ͠Δ API Λۦ͠ ͯಠࣗπʔϧ࡞Δ͜ͱՄೳ
Linter: conventional-changelog-lint https://github.com/marionebl/conventional-changelog-lint
πʔϧͱͷ࿈ܞ Gulp changelog ੜΛλεΫʹΑΔࣗಈԽ https://github.com/conventional-changelog/gulp-conventional-changelog Grunt GitHub Release ΛλεΫʹΑΔࣗಈԽ https://github.com/conventional-changelog/grunt-conventional-github-releaser
Atom https://github.com/conventional-changelog/atom-conventional-changelog
Atom ʹఏڙ͞Ε͍ͯΔπʔϧ Changelog Λੜɺ·ͨ GitHub Release ͕Ͱ͖Δ
ͦͷଞศརπʔϧ standard-changelog Angluar ίϛοτϝοηʔδنʹಛԽͨ͠πʔϧ https://github.com/conventional-changelog/standard-changelog standard-version Angular ίϛοτϝοηʔδنϕʔεͰɺchangelog ੜɺࣗ ಈόʔδϣχϯά͠ɺGitHub
Squash ͞Εͨίϛοτϩάʹର Ԡ https://github.com/conventional-changelog/standard-version conventional-recommended-bump Ͳͷόʔδϣϯ(major/minior/patch)Ξοϓͳͷ͔ڭ͑ͯ͘ΕΔ πʔϧ https://github.com/conventional-changelog/conventional-recommended-bump
ར༻͍ͯ͠ΔϓϩδΣΫτ Conventional Changelog https://github.com/conventional-changelog Angular https://github.com/angular/angular Karma https://github.com/karma-runner/karma JSHint https://github.com/jshint/jshint
Vue.js (vue-validator) https://github.com/vuejs/vue-validator … ͳͲ
·ͱΊ changelog ॏཁͳͷ Conventional Changelog ͰΊΜͲ͏ͳ changelog Λࣗಈੜ͢Δ͜ ͱ͕Ͱ͖Δ Conventional
Changelog ͍Ζ͍Ζศར CLI πʔϧͱΧελϚΠζΛ ఏڙ ίϛοτϝοηʔδن changelog ग़ྗςϯϓϨʔτ API ͳͲ ಋೖ͢Δ͜ͱͰιϑτΣΞ։ൃͷཤྺཧͷΈͳͣɺϦϦʔεɺόʔ δϣχϯάͱָ͔ʹͳΕΔ
Happy changelogging!!