フォーマットのためのGitHubActions #261
Replies: 8 comments 25 replies
-
そもそも現状どうなっているか
package.json "lint-staged": {
"*.{vue, ts, js}": "eslint --fix",
"*.{js,jsx,ts,tsx,vue,css,html,md,json,cjs}": "prettier --write"
}参考 |
Beta Was this translation helpful? Give feedback.
-
GitHubActionsをしたあとに、再びコミットしようとしたら発生したエラー# list-stagedを準備スタート
[STARTED] Preparing lint-staged...
# list-staged 準備できた
[COMPLETED] Preparing lint-staged...
# ステージされたファイルに対してタスクを実行 -> tasks がなんなのか？ -> たぶん package.jsonに書かれたこと？ -> 調査
[STARTED] Running tasks for staged files...
[STARTED] package.json — 1 file
[STARTED] *.{vue, ts, js} — 0 files
[STARTED] *.{js,jsx,ts,tsx,vue,css,html,md,json,cjs} — 1 file
[SKIPPED] *.{vue, ts, js} — no files
# Prettier のフォーマット開始
[STARTED] prettier --write
# Prettier のフォーマット終了
[COMPLETED] prettier --write
[COMPLETED] *.{js,jsx,ts,tsx,vue,css,html,md,json,cjs} — 1 file
[COMPLETED] package.json — 1 file
[COMPLETED] Running tasks for staged files...
# タスクからの修正を適応
[STARTED] Applying modifications from tasks...
# 失敗:
[FAILED] Prevented an empty git commit!
[STARTED] Reverting to original state because of errors...
[COMPLETED] Reverting to original state because of errors...
[STARTED] Cleaning up temporary files...
[COMPLETED] Cleaning up temporary files...
⚠ lint-staged prevented an empty git commit.
Use the --allow-empty option to continue, or check your task configuration
husky - pre-commit script failed (code 1) |
Beta Was this translation helpful? Give feedback.
-
|
huskyの厳密な動きを知りたい |
Beta Was this translation helpful? Give feedback.
-
|
GPTより
|
Beta Was this translation helpful? Give feedback.
-
GitHubActionsでのエラー |
Beta Was this translation helpful? Give feedback.
-
format.ymlname: Format Code
on:
# プルリクエストが開かれた時に実行する
pull_request:
types:
- opened
# 手動でも実行できるようにする
workflow_dispatch:
# 作業内容
jobs:
format:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
# Node.js をセット
- name: Set up Node.js
uses: actions/setup-node@v4
with:
node-version: '20'
# npm install で依存関係をインストール
- name: Install dependencies
run: npm install
- name: Run Prettier
run: npm run format
- name: Run Linter
run: npm run lint
- name: Check for formatting changes
run: git diff --exit-code
continue-on-error: true |
Beta Was this translation helpful? Give feedback.
-
現状
|
Beta Was this translation helpful? Give feedback.
-
これは確かにそうですね！
プロジェクトのmainブランチに対してのpush（現在走っているデプロイのワークフロー）のタイミングでの実行なら、 あれ、もしかしたら自分が何か勘違いしているかもなので、 |
Beta Was this translation helpful? Give feedback.
-
|
以下のような感じでできたら良さそう。。なのかも？と思っている感じです！
|
Beta Was this translation helpful? Give feedback.
-
|
ご確認ありがとうございます！ 個人的には特に相違はないかな...？と思っていましたが、どうでしょう😳！？あら？😱私こそなにか勘違いしてるかもしれません！
こちらですが、ご意見を確認した上でまとめると デプロイ時、以下のGitHub Actionsの流れの中で Node.js のセットアップが終わった後に Prettier と Linter 走らせてビルドするのが良いかなと思いました。 ↑このコードのあとにフォーマットを走らせるイメージ 自分の思っている最終形態 YML（コード折りたたんでます）これで正しく動くかは検証が必要ですが、以下を想定しています。 # Sample workflow for building and deploying a Next.js site to GitHub Pages
#
# To get started with Next.js see: https://nextjs.org/docs/getting-started
#
name: Deploy Next.js site to Pages
on:
# Runs on pushes targeting the default branch
push:
branches: ["main"]
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Detect package manager
id: detect-package-manager
run: |
if [ -f "${{ github.workspace }}/yarn.lock" ]; then
echo "manager=yarn" >> $GITHUB_OUTPUT
echo "command=install" >> $GITHUB_OUTPUT
echo "runner=yarn" >> $GITHUB_OUTPUT
exit 0
elif [ -f "${{ github.workspace }}/package.json" ]; then
echo "manager=npm" >> $GITHUB_OUTPUT
echo "command=ci" >> $GITHUB_OUTPUT
echo "runner=npx --no-install" >> $GITHUB_OUTPUT
exit 0
else
echo "Unable to determine package manager"
exit 1
fi
- name: Setup Node
uses: actions/setup-node@v4
with:
node-version: "20"
cache: ${{ steps.detect-package-manager.outputs.manager }}
- name: Setup Pages
uses: actions/configure-pages@v4
with:
# Automatically inject basePath in your Next.js configuration file and disable
# server side image optimization (https://nextjs.org/docs/api-reference/next/image#unoptimized).
#
# You may remove this line if you want to manage the configuration yourself.
static_site_generator: next
- name: Restore cache
uses: actions/cache@v4
with:
path: |
.next/cache
# Generate a new cache whenever packages or source files change.
key: ${{ runner.os }}-nextjs-${{ hashFiles('**/package-lock.json', '**/yarn.lock') }}-${{ hashFiles('**.[jt]s', '**.[jt]sx') }}
# If source files changed but packages didn't, rebuild from a prior cache.
restore-keys: |
${{ runner.os }}-nextjs-${{ hashFiles('**/package-lock.json', '**/yarn.lock') }}-
- name: Install dependencies
run: ${{ steps.detect-package-manager.outputs.manager }} ${{ steps.detect-package-manager.outputs.command }}
# 🟥 フォーマット スタート 🟥
- name: Run Prettier
run: npm run format
- name: Run Linter
run: npm run lint
# 🟥 フォーマット 終わり 🟥
- name: Build with Next.js
run: ${{ steps.detect-package-manager.outputs.runner }} next build
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./out
# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4もし、デプロイ後にフォーマット用のGitHubActionsがmainブランチで走ってコードの変更があった場合、またビルドしなくちゃいけなくなると思うので...！ |
Beta Was this translation helpful? Give feedback.
-
あ、こちらの投稿今気がつきました！ そんな感じですかね！ |
Beta Was this translation helpful? Give feedback.
-
確かにそうですね！ 認識も同じでした！！w |
Beta Was this translation helpful? Give feedback.
-
|
「git diff –exit-code」が不要なのかもです！
これだけでは、フォーマットに対してコミットが積まれていない感じかもです |
Beta Was this translation helpful? Give feedback.
-
|
その上で、git-auto-commit-actionという、アクションをワークフロー内で使えるので、これが便利かもです！ 下記などでも、 |
Beta Was this translation helpful? Give feedback.
-
|
Beta Was this translation helpful? Give feedback.
-
|
とりあえず変更してみて 以下、疑問点、知りたいこと。
|
Beta Was this translation helpful? Give feedback.
-
|
GPTメモ
name: Deploy Next.js site to Pages
on:
push:
branches: ["main"]
workflow_dispatch:
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
# Format job
format:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Set up Node.js
uses: actions/setup-node@v4
with:
node-version: '20'
- name: Install dependencies
run: npm install
- name: Run Prettier
run: npm run format
- name: Run Linter
run: npm run lint
- name: Check for formatting changes
run: git diff --exit-code
continue-on-error: true
- name: Auto commit formatting changes
uses: stefanzweifel/git-auto-commit-action@v5
with:
commit_message: "[GitHubActions] Format"
# Build job
build:
runs-on: ubuntu-latest
needs: format
permissions:
contents: read
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Set up Node.js
uses: actions/setup-node@v4
with:
node-version: '20'
cache: 'npm'
- name: Setup Pages
uses: actions/configure-pages@v4
with:
static_site_generator: next
- name: Restore cache
uses: actions/cache@v4
with:
path: |
.next/cache
key: ${{ runner.os }}-nextjs-${{ hashFiles('**/package-lock.json', '**/yarn.lock') }}-${{ hashFiles('**.[jt]s', '**.[jt]sx') }}
restore-keys: |
${{ runner.os }}-nextjs-${{ hashFiles('**/package-lock.json', '**/yarn.lock') }}-
- name: Install dependencies
run: npm ci
- name: Build with Next.js
run: npm run build
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: .next
# Deployment job
deploy:
runs-on: ubuntu-latest
needs: build
permissions:
contents: read
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4 |
Beta Was this translation helpful? Give feedback.
-
|
#263 マージした結果、エラーに。 とりあえずGPTにいれてみたところ、こういうことだった。 このエラーメッセージは、GitHub Actionsが
この問題を解決するには、次のステップを試してみてください：
これで問題が解決するはずです。 |
Beta Was this translation helpful? Give feedback.
-
|
あ、確かに、、ですね。！
|
Beta Was this translation helpful? Give feedback.
-
|
ちょっと一晩眠りながら考えます...！🛏️ |
Beta Was this translation helpful? Give feedback.
-
|
遅くまでありがとうございます🙌 一旦戻すなら、打ち消すPRのページからrevertしちゃっても大丈夫ですよ！ |
Beta Was this translation helpful? Give feedback.
-
|
ざっと思いつくのは、こんな感じでしょうか：
|
Beta Was this translation helpful? Give feedback.
-
こういう時に revert すればいいんですね！ありがとうございます！
方法については少し考えますね...！ |
Beta Was this translation helpful? Give feedback.
-
色々調査、情報整理のために書いていきます
related
関係あるかわからないが気になった記事
Beta Was this translation helpful? Give feedback.
All reactions