Skip to main content

GitHub Packagesのクイックスタート

GitHub Packagesを使用してGitHub Actionsに発行します。

はじめに

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

パッケージを公開する

  1. GitHubに新しいリポジトリを作成し、Node の.gitignoreを追加します。 詳しくは、「新しいリポジトリの作成」をご覧ください。

  2. ローカル コンピューターにリポジトリを複製します。

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

    JavaScript
    console.log("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
      ...
    
  5. 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
    
  6. .github/workflows ディレクトリを作成します。 そのディレクトリ内に、release-package.yml という名前のファイルを作成します。

  7. 次の YAML コンテンツを release-package.yml ファイルにコピー。

    YAML
    name: Node.js Package
    
    on:
      release:
        types: [created]
    
    jobs: