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
520
Vapor Revolution
kazupon
3
3.7k
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
8k
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
Sansan Engineering Unit 紹介資料
sansan33
PRO
1
3k
「使い方教えて」「事例教えて」じゃもう遅い! Microsoft 365 Copilot を触り倒そう!
taichinakamura
0
440
Bill One 開発エンジニア 紹介資料
sansan33
PRO
4
14k
Geospatialの世界最前線を探る [2025年版]
dayjournal
1
240
データ戦略部門 紹介資料
sansan33
PRO
1
3.8k
やる気のない自分との向き合い方/How to Deal with Your Unmotivated Self
sanogemaru
1
520
防災デジタル分野での官民共創の取り組み (2)DIT/CCとD-CERTについて
ditccsugii
0
310
事業開発におけるDify活用事例
kentarofujii
2
440
dbtとBigQuery MLで実現する リクルートの営業支援基盤のモデル開発と保守運用
recruitengineers
PRO
3
120
これがLambdaレス時代のChatOpsだ!実例で学ぶAmazon Q Developerカスタムアクション活用法
iwamot
PRO
8
1.1k
『バイトル』CTOが語る! AIネイティブ世代と切り拓くモノづくり組織
dip_tech
PRO
1
130
Introduction to Bill One Development Engineer
sansan33
PRO
0
300
Featured
See All Featured
Typedesign – Prime Four
hannesfritz
42
2.8k
Side Projects
sachag
455
43k
JavaScript: Past, Present, and Future - NDC Porto 2020
reverentgeek
52
5.6k
I Don’t Have Time: Getting Over the Fear to Launch Your Podcast
jcasabona
33
2.5k
Building Better People: How to give real-time feedback that sticks.
wjessup
369
20k
BBQ
matthewcrist
89
9.8k
Code Review Best Practice
trishagee
72
19k
Keith and Marios Guide to Fast Websites
keithpitt
411
23k
The Straight Up "How To Draw Better" Workshop
denniskardys
238
140k
The Success of Rails: Ensuring Growth for the Next 100 Years
eileencodes
46
7.7k
Navigating Team Friction
lara
190
15k
Testing 201, or: Great Expectations
jmmastey
45
7.7k
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!!