Merge pull request #918 from syucream/fix/use-npm-package

Finally use published API client package; goodbye repository-owned client!

Author: hinashi

.babelrc

@@ -13,37 +13,58 @@ on:
 jobs:
   lint:
     runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: read
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
           node-version: 16
+          registry-url: https://npm.pkg.github.com/
+          scope: '@dmm-com'
           cache: 'npm'
       - name: install dependencies
         run: npm ci
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}
       - name: lint
         run: npm run lint
   build:
     runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: read
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
           node-version: 16
+          registry-url: https://npm.pkg.github.com/
+          scope: '@dmm-com'
           cache: 'npm'
       - name: install dependencies
         run: npm ci
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}
       - name: build
         run: npm run build:development
   test:
     runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: read
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
           node-version: 16
+          registry-url: https://npm.pkg.github.com/
+          scope: '@dmm-com'
           cache: 'npm'
       - name: install dependencies
         run: npm ci
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}
       - name: test
         run: npm run test

.github/workflows/build-frontend.yml

@@ -6,9 +6,9 @@ on:
   pull_request_target:
     types: [labeled]
     paths:
-      - '**/api_v2/**/*.py'
-      - 'apiclient/typescript-fetch/package.json'
-      - '.github/workflows/release-apiv2-client.yml'
+      - "**/api_v2/**/*.py"
+      - "apiclient/typescript-fetch/package.json"
+      - ".github/workflows/release-apiv2-client.yml"
 
 jobs:
   release:
@@ -29,7 +29,7 @@ jobs:
           sudo apt-get install libldap2-dev libsasl2-dev libxmlsec1-dev libmysqlclient-dev pkg-config
       - uses: actions/setup-python@v4
         with:
-          python-version: '3.10'
+          python-version: "3.10"
       - name: venv
         run: |
           python3 -m venv virtualenv
@@ -46,13 +46,13 @@ jobs:
         with:
           node-version: 16
           registry-url: https://npm.pkg.github.com/
-          scope: '@dmm-com'
+          scope: "@dmm-com"
       - name: install dependencies
         run: npm ci
         env:
           NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}
       - name: generate client
-        run: npm run generate:client:new
+        run: npm run generate:client
       - run: npm publish
         env:
           NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}
@@ -62,7 +62,7 @@ jobs:
         id: fc
         with:
           issue-number: ${{ github.event.pull_request.number }}
-          comment-author: 'github-actions[bot]'
+          comment-author: "github-actions[bot]"
           body-includes: "<!-- release-apiv2-client-notification -->"
       - name: Create or update comment
         uses: peter-evans/create-or-update-comment@v3

.github/workflows/release-apiv2-client.yml

@@ -177,6 +177,7 @@ static/js/ui.js*
 airone/settings.py
 
 # Auto-generated APIv2 client implementations
+frontend/src/apiclient/autogenerated/
 apiclient/typescript-fetch/src/autogenerated/
 
 # helm

.gitignore

@@ -0,0 +1 @@
+@dmm-com:registry=https://npm.pkg.github.com

.npmrc

@@ -298,6 +298,29 @@ user@hostname:~/airone$ cp -pi ./frontend/src/App.tsx ./frontend/src/customview/
 user@hostname:~/airone$ npm run build:custom
 ```
 
+### API V2 client
+
+Prepare to install API client npm package published on GitHub Packages.
+`TOKEN` is a your GitHub PAT. Issue your PAT with checking [this doc](https://docs.github.com/ja/packages/working-with-a-github-packages-registry/working-with-the-npm-registry#github-packages-%E3%81%B8%E3%81%AE%E8%AA%8D%E8%A8%BC%E3%82%92%E8%A1%8C%E3%81%86).
+Then, you just perform `npm install` as usual.
+
+```
+$ cat > .npmrc
+//npm.pkg.github.com/:_authToken=TOKEN
+```
+
+You can refer your local API client code before publishing it to GitHub Packages with following command.
+
+```shell
+# generate the latest API client code on your local env
+$ npm run generate:client
+
+# refer the latest code temporarily
+$ npm run link:client
+```
+
+If you modify something in API client code, you need to publish it with the package release GitHub Actions workflow. It will be triggered by labeling `release-apiv2-client` to the pull request by repository owners.
+
 ## Auto-format
 
 ```

README.md

@@ -1,6 +1,6 @@
 {
   "name": "@dmm-com/airone-apiclient-typescript-fetch",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "AirOne APIv2 client in TypeScript",
   "main": "src/autogenerated/index.ts",
   "scripts": {

apiclient/typescript-fetch/package.json

@@ -0,0 +1,11 @@
+module.exports = {
+  "presets": [
+    "@babel/preset-react",
+    [
+      "@babel/preset-env", { "targets": { "node": "current" } }
+    ]
+  ],
+  "plugins": [
+    "transform-class-properties"
+  ]
+};