From 709262c794b498cb9e793936157936fc38fe7997 Mon Sep 17 00:00:00 2001 From: Oscar Busk Date: Thu, 12 Aug 2021 12:31:09 +0200 Subject: [PATCH 1/7] Add ci script to check examples --- .github/workflows/check_examples.yml | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 .github/workflows/check_examples.yml diff --git a/.github/workflows/check_examples.yml b/.github/workflows/check_examples.yml new file mode 100644 index 000000000000000..78f96f3ad0c481a --- /dev/null +++ b/.github/workflows/check_examples.yml @@ -0,0 +1,9 @@ +name: check-examples +on: [push, pull_request] +jobs: + check-examples: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - name: Check examples + run: ./scripts/check-examples.sh From a634f6555102c5b5c97d2189417ff2b21a927a99 Mon Sep 17 00:00:00 2001 From: Oscar Busk Date: Thu, 12 Aug 2021 12:40:33 +0200 Subject: [PATCH 2/7] Install moreutils for `sponge` command. It's not very pretty, but I'm not sure how to replace sponge in a good way in the shell script --- .github/workflows/check_examples.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/check_examples.yml b/.github/workflows/check_examples.yml index 78f96f3ad0c481a..7622c14ba9a6038 100644 --- a/.github/workflows/check_examples.yml +++ b/.github/workflows/check_examples.yml @@ -5,5 +5,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 + - name: Install moreutils + run: sudo apt install moreutils - name: Check examples run: ./scripts/check-examples.sh From 3e1ca3e8bbffe23f6f31e5817cde32383cf5cca2 Mon Sep 17 00:00:00 2001 From: Oscar Busk Date: Thu, 12 Aug 2021 12:42:39 +0200 Subject: [PATCH 3/7] Prettier names in the workflow --- .github/workflows/check_examples.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/check_examples.yml b/.github/workflows/check_examples.yml index 7622c14ba9a6038..6802fd381575a56 100644 --- a/.github/workflows/check_examples.yml +++ b/.github/workflows/check_examples.yml @@ -1,7 +1,8 @@ -name: check-examples +name: Check examples on: [push, pull_request] jobs: check-examples: + name: Check exampels runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 From a55a02f99f58a950b2fed0c23778c1e2d8775039 Mon Sep 17 00:00:00 2001 From: Oscar Busk Date: Thu, 12 Aug 2021 19:20:41 +0200 Subject: [PATCH 4/7] Move "check-examples" into build_test_deploy workflow --- .github/workflows/build_test_deploy.yml | 10 ++++++++++ .github/workflows/check_examples.yml | 12 ------------ 2 files changed, 10 insertions(+), 12 deletions(-) delete mode 100644 .github/workflows/check_examples.yml diff --git a/.github/workflows/build_test_deploy.yml b/.github/workflows/build_test_deploy.yml index 53ceba2afadb445..06d04a013861a2b 100644 --- a/.github/workflows/build_test_deploy.yml +++ b/.github/workflows/build_test_deploy.yml @@ -8,6 +8,16 @@ on: name: Build, test, and deploy jobs: + check-examples: + name: Check examples + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - name: Install moreutils + run: sudo apt install moreutils + - name: Check examples + run: ./scripts/check-examples.sh + build: runs-on: ubuntu-latest env: diff --git a/.github/workflows/check_examples.yml b/.github/workflows/check_examples.yml deleted file mode 100644 index 6802fd381575a56..000000000000000 --- a/.github/workflows/check_examples.yml +++ /dev/null @@ -1,12 +0,0 @@ -name: Check examples -on: [push, pull_request] -jobs: - check-examples: - name: Check exampels - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v2 - - name: Install moreutils - run: sudo apt install moreutils - - name: Check examples - run: ./scripts/check-examples.sh From 57253d5e4e58be5944ebb7e1d143cc65f32ddde3 Mon Sep 17 00:00:00 2001 From: Oscar Busk Date: Sat, 14 Aug 2021 14:26:00 +0200 Subject: [PATCH 5/7] Start breaking the jq script into multiple lines --- scripts/check-examples.sh | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/scripts/check-examples.sh b/scripts/check-examples.sh index 15eeeec3bf17317..219534a45a22589 100755 --- a/scripts/check-examples.sh +++ b/scripts/check-examples.sh @@ -3,7 +3,10 @@ for folder in examples/* ; do if [ -f "$folder/package.json" ]; then cp -n packages/create-next-app/templates/default/gitignore $folder/.gitignore; - cat $folder/package.json | jq '.license = "MIT" | .private = true' | sponge $folder/package.json + cat $folder/package.json | jq ' + .license = "MIT" | + .private = true + ' | sponge $folder/package.json fi if [ -f "$folder/tsconfig.json" ]; then cp packages/create-next-app/templates/typescript/next-env.d.ts $folder/next-env.d.ts From fd2947d3f8e9125c620fc1544e155c745e95d021 Mon Sep 17 00:00:00 2001 From: Oscar Busk Date: Sat, 14 Aug 2021 14:30:06 +0200 Subject: [PATCH 6/7] Add checks for cleanups in vercel/next.js#27121 --- scripts/check-examples.sh | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/scripts/check-examples.sh b/scripts/check-examples.sh index 219534a45a22589..0c5e92a57717918 100755 --- a/scripts/check-examples.sh +++ b/scripts/check-examples.sh @@ -4,8 +4,8 @@ for folder in examples/* ; do if [ -f "$folder/package.json" ]; then cp -n packages/create-next-app/templates/default/gitignore $folder/.gitignore; cat $folder/package.json | jq ' - .license = "MIT" | - .private = true + .private = true | + del(.license, .version, .name, .author, .description) ' | sponge $folder/package.json fi if [ -f "$folder/tsconfig.json" ]; then From e12bc1e8f51c78832b71e2f9009843e9b8b74d4f Mon Sep 17 00:00:00 2001 From: Oscar Busk Date: Sat, 14 Aug 2021 18:01:35 +0200 Subject: [PATCH 7/7] Run the `check-examples.sh` script to cleanup all remaining examples. --- examples/with-cypress/package.json | 2 -- examples/with-fauna/package.json | 3 --- examples/with-jotai/next-env.d.ts | 3 +++ examples/with-jotai/package.json | 1 - 4 files changed, 3 insertions(+), 6 deletions(-) diff --git a/examples/with-cypress/package.json b/examples/with-cypress/package.json index 966a833f699b43a..d277dee94d4a8ed 100644 --- a/examples/with-cypress/package.json +++ b/examples/with-cypress/package.json @@ -1,6 +1,4 @@ { - "name": "with-cypress", - "version": "0.1.0", "private": true, "scripts": { "dev": "next dev", diff --git a/examples/with-fauna/package.json b/examples/with-fauna/package.json index 41dffe6d07ac517..ebc9afc85ade3a4 100644 --- a/examples/with-fauna/package.json +++ b/examples/with-fauna/package.json @@ -1,8 +1,5 @@ { "private": true, - "name": "with-fauna", - "version": "1.0.0", - "description": "Guestbook example with Next.js and Fauna.", "scripts": { "dev": "next", "build": "yarn setup && next build", diff --git a/examples/with-jotai/next-env.d.ts b/examples/with-jotai/next-env.d.ts index c6643fda12ff6f8..9bc3dd46b9d9b21 100644 --- a/examples/with-jotai/next-env.d.ts +++ b/examples/with-jotai/next-env.d.ts @@ -1,3 +1,6 @@ /// /// /// + +// NOTE: This file should not be edited +// see https://nextjs.org/docs/basic-features/typescript for more information. diff --git a/examples/with-jotai/package.json b/examples/with-jotai/package.json index d7fa2a4cef5e4a4..91fbf560cd20da9 100644 --- a/examples/with-jotai/package.json +++ b/examples/with-jotai/package.json @@ -1,5 +1,4 @@ { - "name": "with-jotai", "private": true, "scripts": { "dev": "next dev",