GitHub Foundaitons ハンズオン のバックアップ(No.7)

[ トップ ]   [ 新規 | 一覧 | 単語検索 | 最終更新 | ヘルプ ]

• バックアップ一覧
• 差分 を表示
• 現在との差分 を表示
• ソース を表示
• GitHub Foundaitons ハンズオン へ行く。
  • 1 (2025-02-21 (金) 17:09:40)
  • 2 (2025-02-21 (金) 19:04:59)
  • 3 (2025-02-21 (金) 23:53:34)
  • 4 (2025-02-22 (土) 18:04:13)
  • 5 (2025-03-05 (水) 16:22:10)
  • 6 (2025-03-05 (水) 18:46:29)
  • 7 (2025-03-05 (水) 23:55:34)
  • 8 (2025-03-06 (木) 14:51:24)
  • 9 (2025-03-06 (木) 17:30:30)
  • 10 (2025-03-06 (木) 18:04:40)
  • 11 (2025-03-14 (金) 14:12:13)

---

「マイクロソフト系技術情報 Wiki」は、「Open棟梁Project」,「OSSコンソーシアム .NET開発基盤部会」によって運営されています。

• 戻る

目次 †

概要 †

https://github.com/alterbooth/hol-github-foundations/tree/main

詳細 †

共通項 †

Settings †

エンティティのセッティングを定義できる。

• 個人Accountの設定
• Repositoryの設定
• Organizationの設定
• Enterpriseの設定

Template †

エンティティのテンプレートを定義できる。

• 以下のテンプレートがある。
  • Repository
  • Issue
  • Pull Request
  • GitHub ActionsのWorkflow

• 以下の定義方法がある。

• 簡単なもの
  • Markdownの形式でテンプレートを作成（*.md）
  • フォーマット（シンプルなガイドラインや記述例）を提供する目的。

• 複雑なもの
  • YAMLで記述でテンプレートを作成（*.yml）
  • マークアップなので複雑な定義が可能。

• 以下の配置場所がある。

• .github -> root -> docs ディレクトリなどに配置。

• 複数ファイルを配置する場合の場所（フォルダ名）は、
  エンティティやドキュメントファイル毎に決まっている。

エンティティ一覧 †

• エンティティによっては、一覧がある。
• 一覧にはフィルタリング用のフィルターが存在する。

• 一覧があるエンティティはピン留めで一番上に来る。
  • Repository、Issue、Discussion、Project
  • Pull Requestにはピン留めはないのでラベルを使う。

ドメイン1: GitとGitHub †

Git and GitHub Basics †

• バージョン管理を説明する
• 分散バージョン管理を定義する
• Git、GitHubの差異を含め説明する
• GitHubリポジトリを説明する
• コミットを説明する
• ブランチを説明する
• Git用語でリモートを定義する
• GitHubフローを説明する

• 機能階層
  Gitを修飾する各種機能が実装されている。

• コード管理・コラボレーション
  • Gitリポジトリ
  • Issue
  • Pull requests
  • Projects
  • Discussions

• 運用支援・開発環境
  • Actions
  • Codespaces
  • Copilot

• セキュリティ
  • Dependabot
  • Code scanning
  • Secret scanning

• 管理
  • Organization
  • Enterprise

• 参考
  • https://dotnetdevelopmentinfrastructure.osscons.jp/index.php?Git
  • https://dotnetdevelopmentinfrastructure.osscons.jp/index.php?Github

GitHub Entities †

• GitHub accounts
  異なるGitHubアカウント（個人、Organization、Enterprise）

• Personal accounts
• Organization accounts
• Enterprise accounts

• GitHubの料金プラン
  • 個人アカウント向けのGitHub製品（Free、Pro）
  • Organizationアカウント向けのGitHub製品（Free、Team）

• GitHub Enterpriseの異なるデプロイメントオプション

• ユーザープロフィールの機能
  メタデータ、実績、プロフィールREADME、リポジトリ、ピン留めされたリポジトリ、スターなど

GitHub Markdown †

• Markdownと、その使用方法
• IssueおよびPull requestコメントなどで使用
• 基本的なフォーマット構文（見出し、リンク、タスクリスト、コメントなど）
• テキストフォーマットツールバーを使用する
• スラッシュコマンドでフォーマット構文を見つける。

GitHub Desktop †

• GitHub Desktopとgithub.comの違い
  • github.com：Gitホスティング・サービス
  • GitHub Desktop：クライアント・ツール

• GitHub Desktopの利用可能な機能
  • GitHub Desktopで開発ワークフローを簡素化
  • クローンしたリポジトリで全てのgit操作を実行

GitHub Mobile †

GitHub Mobileの利用可能な機能

• 素早くIssueやプルリクエストのダッシュボードにアクセス
• 外出先でプルリクエストを承認
• モバイル最適化デザインでGitHubを閲覧し共同作業できる。
• GitHubの様々なエレメント的なものを検索
• GitHubの様々な通知を管理する。

ハンズオン: GitとGitHub操作 †

https://github.com/alterbooth/hol-github-foundations/tree/main/domain1

• リポジトリの作成
• リポジトリをローカルにGitクローン
• （生のGitやVSCodeやCodespacesのターミナルを使うなど）
• Git操作、作業用ブランチ作成、README.mdを編集（gitのコマンドでadd commit push）
• GitHub操作、README.mdを編集、markdownを色々書いて、コミットする。
• Git操作、ブランチをプル、README.mdの変更結果を確認（gitのコマンドでpull）
• GitHub Desktop、GitHub Mobileなどを使用して共同作業をやってみる。

ドメイン2: リポジトリ †

リポジトリのドキュメントファイル †

• 良いREADMEの構成要素と推奨されるリポジトリファイル
• .github -> root -> docs ディレクトリなどに配置する。
• モノによっては、表示に関する優先順位がある。

• README.md
  • プロジェクトの概要や使い方を記載するファイル。
  • インストール手順、使い方、サンプルコード、ライセンス情報などが含まれる。
  • TOPに表示される優先順は、.github -> root -> docs ディレクトリ

• LICENSE.md
  • ソフトウェアのライセンス情報を記載するファイル。
  • MIT, Apache, GPL などのライセンス条文が記載される。

• CODEOWNERS.md
  • リポジトリ内の特定のファイルやディレクトリに対する責任者（コードオーナー）を定義
  • プルリクエストの自動レビュー割り当てなどに使用される。

• CONTRIBUTING.md
  • プロジェクトへの貢献方法（コントリビューションガイド）を記載するファイル。
  • プルリクエストのルール、コードスタイル、バグ報告の手順などが含まれる。

• CODE_OF_CONDUCT.md
  • プロジェクトの行動規範（Code of Conduct）を定めたファイル。
  • コミュニティ内での適切な行動や禁止事項などを記載する。

• SECURITY.md
  • セキュリティに関するガイドラインや脆弱性の報告方法を記載するファイル。
  • セキュリティリスクや脆弱性の開示ポリシーなどが含まれる。

• SUPPORT.md
  • プロジェクトのサポートに関する情報を記載するファイル。
  • 問い合わせ方法、FAQ、フォーラムやGitHub Issuesの利用方針などが含まれる。

• FUNDING.yml
  • GitHub Sponsors や Open Collective などの資金提供手段を設定
  • プロジェクトの開発支援を希望する場合に記載

• CITATION.cff
  • プロジェクトの引用方法（学術論文向け）を記載するファイル。
  • .cff（Citation File Format）を使用し、研究者が論文などでプロジェクトを正しく引用できるようにする。

基本的なリポジトリのナビゲーション †

• リポジトリの名前
• リポジトリの情報
• リポジトリのREADME表示

• ナビゲーション
  • Code
  • Issues
  • Pull requests
  • Actions
  • Projects
  • Wiki
  • Security
  • Insights
  • Settings
    • General → Template Repository

• Branches
• Commits（履歴）

• コードの取得・展開
  • clone

新しいリポジトリの作成方法 †

• 新しいリポジトリの作成
• 新しいブランチの作成
• リポジトリにファイルを追加
• リポジトリのインサイトを表示
• スターを使ってリポジトリをお気に入り登録

• 機能プレビュー（Feature preview）はプロファイルアイコンから
  • Colorblind themes
  • Command Palette
  • Copilot Workspace for Pull Requests
  • Personal Instructions
  • New Commit Details Page
  • Rich Jupyter Notebook Diffs
  • New Issues Experience
  • New merge experience
  • Enhanced Repos Insights Views
  • Slash Commands

テンプレートリポジトリ †

• テンプレートリポジトリを作成
• 新しいリポジトリの作成

ハンズオン: リポジトリ操作 †

https://github.com/alterbooth/hol-github-foundations/blob/main/domain2/README.md

• 機能プレビュー（Feature preview）のNew Issues ExperienceをDisabledにしておく（手順書とUIが変わるので）。

• テンプレートリポジトリを使用してリポジトリを作成
  • ハンズオン１で作成したリポジトリに移動
  • リポジトリのナビゲーションを確認
  • このリポジトリをテンプレートリポジトリとしてマーク
  • テンプレートリポジトリを使用してリポジトリを作成

• 作成したリポジトリを編集する
  • Github上でブランチを作成
  • Github上でファイル（README）を追加
  • Github上でファイル（README）を確認
  • リポジトリにstarを付ける

ドメイン3: 共同作業機能 †

Issue、Pullrequest、Discussionの違い

• Issue
  • シンプルなタスクを登録し、管理する。
  • Pull requestsやProjectsと組み合わせ複雑なタスク管理に対応。

• Pullrequest
  • Gitのブランチ間の差分から作成
  • 変更内容をレビューするために利用

• Discussion
  • 議論や質疑応答
  • アイディアやフィードバックの収集
  • Issueに起こす前段階の議論や調査

Issues †

• Issueの作成、IssueからBranchを作成

• Issueを検索およびフィルタリング
  • フィルタによる絞込み、検索
  • プルダウンでフィルタ追加して絞込み、検索

• 基本的なIssue管理

• 割り当て
  • 担当者
  • Label、Milestone、Project
  • Development: Branch、PullRequest?

• ピン留め
• #による各種リンク
• 重複としてマーク（Duplicate of #xx）
• クローズ、再オープン、転送、削除

• Issueキーワード
  • 特定のアクションを自動化
  • Issueやプルリクエストの状態を管理

• Issue TemplateとIssue Form
  • 複数作成できる。
  • 定義ファイルは.github/ISSUE_TEMPLATE/に置く。

• Issue Template
  • Markdownの形式でテンプレートを作成（*.md）
  • ユーザーが自由に編集できる（入力必須項目などの制約なし）

• Issue Form
  • YAMLで記述でテンプレートを作成（*.yml）
  • 構造化されたIssueを作成
  • フォームで必須項目を設定し入力を強制
  • 入力フィールドの種類を指定可能

Pull requests †

• Pull requestの作成
  • Pull requestのタブ
  • ベースブランチと比較ブランチ
  • Issueと比較すると追加でReviewersを指定できる。
  • テンプレートの活用して作成できる。

• Pull requestのステータス
  • Draft（ドラフト）：作業中のPRで、レビューやマージがまだ行われない状態。
  • Open（オープン）：PRが作成され、まだマージやクローズされていない状態。
  • Closed（クローズ）：PRがマージされずに終了した状態。
  • Merged（マージ済み）：PRの変更がメインブランチなどに統合された状態。

• アクティビティをリンク
  • 別のPull Requestを参照
  • Issueを参照
    • Issue連動クローズのキーワード
    • メタデータのDevelopmentから追加
  • コメントをリンク
  • コミットをリンク
  • コードの特定行をリンク

• ナビゲーション

• Conversation（会話）
  • PRの概要やディスカッションのやりとりが表示されるタブ。
  • レビューコメントやステータス、マージの可否に関する情報を表示

• Commits（コミット）
  • PRに含まれるコミットの一覧が表示されるタブ。
  • それぞれのコミットメッセージや変更履歴を確認

• Checks（チェック）
  • CI/CDのステータスや、自動テストの結果が表示されるタブ。
  • 失敗したチェックの詳細を確認し、修正が必要かどうか判断

• Files changed（変更されたファイル）
  • PRで変更されたファイルの一覧が表示されるタブ。
  • 変更内容を差分表示で確認し、コードレビューを行う

• レビュー関連

• ファイルのコード行へのリンクにコメント

• レビューを行う
  • 単一コメント：「Add single comment」
  • 複数コメント：「Start a review - Finish your review」

• コメントの書き方
  • 変更の提案（suggested changes）は```suggestion - ```と書く。
  • 変更の提案を、提案の確定（commit suggestion）で反映できる。

• レビュー結果のステータス
  Review changes（Finish your review）でオプション選択

• コメント（Comment）
  変更の提案やフィードバックを提供する場合に選択
• 承認（Approve）
  変更を承認する場合に選択
• 変更要求
  修正が必要であることを示す場合に選択

• 既定のレビュアーをCODEOWNERSファイルに指定しておくと良い。

Discussions †

• Issuesとは異なり、コードに関連しない会話や質問、情報共有を行うための場で2021年8月に正式版となった。
• 既定でOFF、リポジトリのナビゲーションのSettingsからDiscussionsを有効化
• Discussionsタブから「New discussion」or「Start a discussion」で新規作成

• DiscussionとIssueの違い

• Issue
  • 主にバグの修正、機能の提案、改善のリクエストなど、具体的な作業に関連するものに使用
  • トラッキングに適したフィールド（ラベル、マイルストーン、プロジェクト）により管理を容易にする。

• Discussions
  • 形式にとらわれない広範で自由なコミュニケーション、議論、アイデアの共有に使用
  • チームメンバーだけでなく、コミュニティ全体が参加できる。

• 初期で用意されているカテゴリ
  • General: 全般
  • Announcements: お知らせ
  • Ideas: アイディア
  • Q&A: 質疑応答
  • Show and tell: 知見共有

• コメントをDiscussionの回答としてマーク
• DiscussionをIssueに変換（自動リンク）
• Discussionをピン留め

Notifications †

• ソース（パブリッシャ的な）
  • Repository、Issue & Pull Request
  • GitHub Actions、Dependabot

• サブスクリプションの管理
  • アクティビティ、イベント
  • Ignored repositories

• 他のオプション
  • エンティティ毎メールアドレスを変える
  • 自動的に追加されるRepository、Teamsの条件

GitHub Gist †

コードスニペットを他の人と共有する簡単な方法を提供

• GistはGitリポジトリであり、作成、フォークやクローンが可能
• Gistはパブリックまたはシークレットに設定可能
• パブリック → シークレットへの変更は不可能
• シークレットは検索にヒットしないだけでURL直アクセスは可能

GitHub Wiki、Pages †

• Wiki
  • リポジトリのドキュメントをWikiに作成できる。
  • Wiki編集はリポジトリへの書き込みアクセス権を持つユーザーができる。

• Pages
  • 静的サイトホスティングサービス
  • ドキュメンテーション・ツールの出力を置く
  • オプションでビルドプロセスを追加できる。

ハンズオン: 共同作業 †

https://github.com/alterbooth/hol-github-foundations/blob/main/domain3/README.md

• Issue
  • 「New issue」ボタンで１つめのIssueを作る。
  • Issueの画面右側のメタデータを確認
  • DevelopmentからIssueをブランチと紐付け
  • ピン留めする。
  • 「New issue」ボタンで２つめのIssueを作る。
  • Issueの一覧で、フィルターやソートをしてみる
  • Issueの一番下のボタンからクローズ（2種類）、再オープン
  • コメントにDuplicate of #1と入力（した後に削除しないでクローズする作法）
  • リポジトリを作成してそちらにIssueを転送してみる。転送を確認ご削除。
  • TemplateとFormsを作って、それを使用してIssueを作成する。

• Pull request
  • ユーザをリポジトリに招待してCODEOWNERSファイルを新規作成しソコにレビュアーとして追加
  • masterブランチを編集し「create a new branch for this commit...」でbrunch しつつ commit ＆ Pull request。
  • Pull requestを新規作成し、Descriptionは適宜入力しつつ、Close #Xを入れる。
  • レビュアーに自動的にCODEOWNERSに追加したアカウント名が追加されたことを確認する。
  • Draft、Close、Reopenなどのステータス変更の操作を試してみる。
  • 説明された様々なレビュー・プロセスを実行し、最後にPull requestをマージする。
  • マージされたらReopenできない。また、Delete brunchボタンからbranchを削除できる。
  • Pull requestテンプレートを作って、テンプレートを使ったPull requestを作ってみる

• Discussions
  • Repository の settings から Discussions を有効化
  • 有効化してDiscussionsが表示されることを確認
  • 「New discussion」ボタンを押し新しいDiscussionsを作成
  • カテゴリの中から「Q&A」の「Get started」を押す
  • TitleとBodyを入力して「Start discussion」を押す
  • 回答を書き込み、「Comment」ボタンを押す
  • 回答として採用するコメントの「Mark as answer」を押す
  • マークされたコメントが回答として表示されることを確認する
  • ピン留めは、全体かカテゴリ毎かを選択可能。
  • Discussionに移動し「Create issue from discussion」からIssueを作成できる。

• Notifications
  • トレイのアイコンを押下するとnotificationsの画面に遷移する。
  • 「Manage notifications」の「Subscriptions」からエンティティ一覧を確認できる。
  • エンティティからIssueを選択＆表示してメタデータからUnsubscribeできる。
  • Repositoryの場合は「Manage notifications」の「Watched repositories」で一覧を確認できる。
  • Repositoryに遷移して、Code の Watchから監視オプションを選択する。
  • 「Manage notifications」の「Notification settings」は個人Accountのsettings → Notificationと同じ。

• GitHub Gist
  • 個人Accountの「Your Gists」から「+」でファイルを開き「Create secret gist」で保存。
  • 「Edit」ボタンを押し、右上の「Make public」ボタンでパブリック化できる（逆はできない）。
  • GitHub Gistは、fork/cloneできる。クローンしローカルで編集してプッシュすることで編集できる。

• GitHub Wiki
  • Wikiは、リポジトリのナビゲーションのWikiから構成できる。
  • Create the first pageで新設、編集したら、Save page。
  • 以降、New pageでページを追加し、編集したら、Save page。
  • Sidebarを作成したりsettings → Features → Wikiから権限を見たり。

• GitHub Pages
  • Pagesは、リポジトリのナビゲーションのPagesから構成できる。
  • Pagesはgh-pagesという別ブランチを作成して公開する方法や
    masterブランチにて「docs」フォルダーを公開する方法があるもよう。

ドメイン4: モダンな開発 †

GitHub Actions †

自動化によるワークフローを更に加速する。

• 20以上のプロジェクト・イベントに対応する自動化トリガーにより、CI/CDだけでなく、あらゆるAPIの呼び出しの自動化が可能
• シンプルで使いやすい（YAMLに基づく設定と、学習および開始に役立つ多数のサンプルワークフロー）
• アクションのためのグローバルコミュニティ（コミュニティおよび企業によって維持されている17,000以上のオープンソースアクション）

• yamlの基本構造

  name: CI Workflow  # ワークフロー名
  
  on:  # トリガー
    push:
      branches:
        - main
    pull_request:
      branches:
        - main
    schedule:
      - cron: '0 12 * * 1'  # 毎週月曜日12:00 UTCに実行
  
  jobs:
    build:  # ジョブの定義
      runs-on: ubuntu-latest  # 実行環境（macos-latest, windows-latest も可）
  
      steps:
        - name: リポジトリをチェックアウト
          uses: actions/checkout@v4
  
        - name: Node.js セットアップ
          uses: actions/setup-node@v4
          with:
            node-version: '20'
  
        - name: 依存関係のインストール
          run: npm install
  
        - name: テスト実行
          run: npm test

• https://github.com/features/actions

GitHub Copilot †

あなたのAIペアプログラマー

• コードをより速く、少ない労力で書くのを助けるAIペアプログラマー
• コメントやコードからコンテキストを引き出し、次の入力や全体の関数を瞬時に提案
• 実装したいロジックをコメントで記述し、GitHub Copilotにコードを組み立てさせる。
• UTパッケージをインポートし、GitHub Copilotにテストコードを提案させる。

• https://github.com/features/copilot/

GitHub Codespaces †

妥協のないコーディング

• ブラウザ内で完全な開発環境を使用して、コードの記述、ビルド、テスト、デバッグ、およびデプロイが可能
• 開発環境のセットアップ時間を週に数時間から数分に短縮、リポジトリへの迅速な貢献を可能にする。
• dotfilesリポジトリやVS Code拡張機能を使用してエディタを設定し、すべてのCodespaceで一貫した環境を作成
• VS CodeのWeb版、デスクトップ版を併用可能（デスクトップ版のリモート環境接続機能を使用）

• github.dev vs Codespaces

• https://github.com/features/codespaces

ハンズオン: モダン開発 †

ドメイン5: プロジェクト管理 †

ドメイン6: プライバシー、セキュリティ、および管理 †

ドメイン7: GitHubコミュニティの利点 †

     

Site admin: dotNetDevelopmentInfrastructure

PukiWiki 1.4.7 Copyright © 2001-2006 PukiWiki Developers Team. License is GPL.
Based on "PukiWiki" 1.3 by yu-ji. Powered by PHP 5.3.3. HTML convert time: 0.080 sec.