Upgrade to Pro — share decks privately, control downloads, hide ads and more …

GitHub の README をいい感じにする / Cool Readme

Taiju Aoki
November 08, 2019

GitHub の README をいい感じにする / Cool Readme

LT for M3 TechTalk

Taiju Aoki

November 08, 2019
Tweet

More Decks by Taiju Aoki

Other Decks in Programming

Transcript

  1. ࢲ͸୭ʁ blue (@blue_1617) https://blue0513.github.io/show_room/ 2 ‣ ΤϜεϦʔגࣜձࣾ ιϑτ΢ΣΞΤϯδχΞ ‣ Emacs,

    Ruby, JavaScript ‣ VisualStudio, C# ‣ ےτϨΛ࠷ۙ͸͡Ίͨ ‣ ମॏ͕4Ωϩۙ͘૿͑ɺ੒ՌΛײ͍ͯ͡Δ ‣ ࠓظΦεεϝΞχϝ ‣ ΞϑϦΧͷαϥϦʔϚϯ
  2. 15 ໨࣍ ‣ README ΛؚΜͩΞϓϦ ‣ GitHub Actions ͱ͸ ‣

    ESLint Λ CI Ͱճ͢ ‣ Jest Λ CI Ͱճ͢ ‣ README ʹ Badge Λ௥Ճ͢Δ
  3. 18 ໨࣍ ‣ README ΛؚΜͩΞϓϦ ‣ GitHub Actions ͱ͸ ‣

    ESLint Λ CI Ͱճ͢ ‣ Jest Λ CI Ͱճ͢ ‣ README ʹ Badge Λ௥Ճ͢Δ
  4. https://github.com/features/actions GitHub Actions 20 https://github.com/features/actions ৄࡉ͸ެࣜΛݟͯ͘Ε͍͞ʂ ‣ CircleCI ΍ Travis

    Λ࢖Θͣʹ CI/CD Ͱ͖Δػೳ ‣ Linux, Windows, macOS ʹ΋ରԠ ‣ 3rd party ੡ͷ Action Λར༻Մೳ ‣ yml Ͱ Workflow ΛఆٛՄೳ ‣ Public Repo: Free! ‣ Private Repo: ैྔ՝ۚੑ
  5. 21 ໨࣍ ‣ README ΛؚΜͩΞϓϦ ‣ GitHub Actions ͱ͸ ‣

    ESLint Λ CI Ͱճ͢ ‣ Jest Λ CI Ͱճ͢ ‣ README ʹ Badge Λ௥Ճ͢Δ
  6. ESLint Λ CI Ͱಈ͔ͯ͠Έͨ 22 $ touch REPOSITORY/.github/workflows/eslint.yml $ emacs

    -nw eslint.yml $ git add --all & git commit -m "add eslint" $ git push yml ΛσΟϨΫτϦʹ௥Ճͯ͠ push ͢Δ
  7. 25 ໨࣍ ‣ README ΛؚΜͩΞϓϦ ‣ GitHub Actions ͱ͸ ‣

    ESLint Λ CI Ͱճ͢ ‣ Jest Λ CI Ͱճ͢ ‣ README ʹ Badge Λ௥Ճ͢Δ
  8. Jest Λ CI Ͱಈ͔ͯ͠Έͨ 26 $ touch REPOSITORY/.github/workflows/jest.yml $ emacs

    -nw jest.yml $ git add --all & git commit -m "add jest" $ git push yml ΛσΟϨΫτϦʹ௥Ճͯ͠ push ͢Δ
  9. 29 ໨࣍ ‣ README ΛؚΜͩΞϓϦ ‣ GitHub Actions ͱ͸ ‣

    ESLint Λ CI Ͱճ͢ ‣ Jest Λ CI Ͱճ͢ ‣ README ʹ Badge Λ௥Ճ͢Δ
  10. README ʹ Badge Λ௥Ճͯ͠Έͨ 35 Markdown ʹຒΊࠐΉ৔߹ɺLink Λॻ͚͹Α͍ ![logo](https://img.shields.io/badge/SlackDeck-Proto-blue) Custom

    Badge ![version](https://img.shields.io/github/v/release/blue0513/slackdeck-proto) Release Version /github/v/release/:user/:repo /travis/:user/:repo , etc ...
  11. README ʹ Badge Λ௥Ճͯ͠Έͨ 36 GitHub Actions ͷ৔߹ɺshields.io Λ࢖Θ͍͚ͣΔ ![jest](https://github.com/blue0513/slackdeck-proto/workflows/jest/badge.svg)

    Jest ![eslint](https://github.com/blue0513/slackdeck-proto/workflows/eslint/badge.svg) ESLint https://github.com/{owner}/{repo}/workflows/{workflow_name}/badge.svg)
  12. ·ͱΊ 42 ‣ GitHub Actions Ͱ CI/CD ΛճͤΔΑ͏ʹͳͬͨ ‣ yml

    ఆٛʹΑͬͯ ESLint, Jest ͳͲ͕࣮ߦ ‣ Public Repository ͸ແྉ ‣ Shields.io Ͱ Badge Λ࡞੒Ͱ͖ΔΑ͏ʹͳͬͨ ‣ Repository ͷ಺༰ΛಡΈऔͬͯࣗಈ࡞੒ ‣ Custom Badge ͰΦϦδφϧײ΋ग़ͤΔ ‣ README ͕ͦΕͬΆ͘ͳͬͨʂ