ドキュメントには頻繁に更新が加えられ、その都度公開されています。本ページの翻訳はまだ未完成な部分があることをご了承ください。最新の情報については、英語のドキュメンテーションをご参照ください。本ページの翻訳に問題がある場合はこちらまでご連絡ください。

GitHub Packagesのクイックスタート

GitHub ActionsでGitHub Packagesに公開します。

ここには以下の内容があります:

ノート: GitHubホストランナーは、現在GitHub Enterprise Serverでサポートされていません。 GitHub public roadmapで、計画されている将来のサポートに関する詳しい情報を見ることができます。

はじめに

このガイドでは、コードをテストするGitHub Actionsワークフローを作成して、それをGitHub Packagesに公開します。

パッケージを公開する

  1. GitHub に新しいリポジトリを作成し、ノードに.gitignoreを追加します。 このパッケージを後で削除したい場合は、プライベートリポジトリを作成します。パブリックパッケージは削除できません。詳しい情報については、「新しいリポジトリを作成する」を参照してください。

  2. リポジトリをローカルマシンにクローンします。

    $ git clone https://github.com/YOUR-USERNAME/YOUR-REPOSITORY.git
    $ cd YOUR-REPOSITORY
  3. index.jsファイルを作成し、「Hello world!」を表示する基本的なアラートを作成します。

    JavaScript
    alert("Hello, World!");
  4. npmパッケージをnpm initで初期化します。 パッケージ初期化ウィザードで、@YOUR-USERNAME/YOUR-REPOSITORYの形式で名前を入力し、テストスクリプトをexit 0に設定します。 これにより、パッケージの情報が付いたpackage.jsonファイルが生成されます。

    $ npm init
      ...
      package name: @YOUR-USERNAME/YOUR-REPOSITORY
      ...
      test command: exit 0
      ...    
  1. npm installを実行してpackage-lock.jsonファイルを生成し、変更をコミットしてGitHubにプッシュします。

    $ npm install
    $ git add index.js package.json package-lock.json
    $ git commit -m "initialize npm package"
    $ git push
  2. .github/workflowsディレクトリを作成します。 このディレクトリ内に、release-package.ymlという名前のファイルを作成します。

  3. 以下の内容のYAMLをrelease-package.ymlファイルにコピーします。.

    YAML
    name: Node.js Package
    
    on:
      release:
        types: [created]
    
    jobs:
      build:
        runs-on: ubuntu-latest
        steps:
          - uses: actions/checkout@v2
          - uses: actions/setup-node@v1
            with:
              node-version: 12
          - run: npm ci
          - run: npm test
    
      publish-gpr:
        needs: build
        runs-on: ubuntu-latest
        steps:
          - uses: actions/checkout@v2
          - uses: actions/setup-node@v1
            with:
              node-version: 12
              registry-url: https://npm.pkg.github.com/
          - run: npm ci
          - run: npm publish
            env:
              NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}
  4. コミットして変更をGitHubにプッシュします。

    $ git add .github/workflows/release-package.yml
    $ git commit -m "workflow to publish package"
    $ git push
  5. 作成したワークフローは、リポジトリに新しいリリースが作成されるたびに実行されます。 テストにパスすると、パッケージはGitHub Packagesに公開されます。

    これを試すには、リポジトリの [Code] タブに移動し、新しいリリースを作成します。 詳しい情報については、「リポジトリのリリースを管理する」を参照してください。

公開したパッケージを表示する

パッケージはリポジトリレベルで公開されます。 リポジトリ内のすべてのパッケージを表示し、特定のパッケージを検索できます。

  1. GitHub Enterprise Serverで、リポジトリのメインページにアクセスしてください。

  2. ファイルのリストの右で、Packagesをクリックしてください。

    概要ページのパッケージリンク

  3. 表示させたいパッケージの名前をクリックしてください。

    パッケージ名

公開したパッケージをインストールする

これでパッケージを公開できたので、プロジェクト全体で依存関係として利用できます。 詳しい情報については、「GitHub Packages で利用するために npm を設定する」を参照してください。

次のステップ

ここで追加した基本的なワークフローは、リポジトリ内に新しいリリースが作成されるたびに実行されます。 ただし、これは GitHub Packages でできることの一部にすぎません。 単一のワークフローで複数のレジストリにパッケージを公開する、ワークフローをトリガーしてマージされたプルリクエストなどさまざまなイベントで実行する、コンテナを管理するなど、いろいろなことができます。

GitHub PackagesとGitHub Actionsを組み合わせることで、プリケーション開発プロセスのほぼすべての要素を自動化するために役立ちます。 始める準備はできましたか? 以下は、GitHub PackagesおよびGitHub Actionsで次のステップへ進むために役立つリソースです。

Did this doc help you?

Privacy policy

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

OR, learn how to contribute.