From 6cb3d40c28d254f290c2f83b7a76adcc78f18209 Mon Sep 17 00:00:00 2001 From: suzuki3jp Date: Mon, 20 Jan 2025 16:58:21 +0900 Subject: [PATCH 1/2] ci: Add job for generating API documentation --- .github/workflows/ci.yml | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index f46f6d8..6f3268a 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -5,6 +5,19 @@ on: workflow_dispatch: jobs: + docs: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Setup Node.js + uses: actions/setup-node@v4 + with: + node-version: "lts/*" + - name: Install dependencies + run: npm ci + - name: Generates api documentation + run: npm run docs vitest: runs-on: ubuntu-latest steps: From bb64f896415e129d726df2d306c4d232267a834a Mon Sep 17 00:00:00 2001 From: suzuki3jp Date: Mon, 20 Jan 2025 17:00:23 +0900 Subject: [PATCH 2/2] fix(PlaylistItemManager): Prevent `tsdoc-param-tag-missing-hyphen` error in `api-extractor` CI job --- src/managers/PlaylistItemManager.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/managers/PlaylistItemManager.ts b/src/managers/PlaylistItemManager.ts index fb81dc8..375b073 100644 --- a/src/managers/PlaylistItemManager.ts +++ b/src/managers/PlaylistItemManager.ts @@ -38,8 +38,8 @@ export class PlaylistItemManager { * - The operation uses 1 quota unit. * * [YouTube Data API Reference](https://developers.google.com/youtube/v3/docs/playlistItems/list) - * @param playlistId - * @param pageToken + * @param playlistId - The ID of the playlist to retrieve items from. + * @param pageToken - The page token to use for pagination. * @returns */ public async getByPlaylistId(