chore: comment diffs automatically #478

atlj · 2023-10-06T15:06:42Z

Summary:

This adds a new workflow that comments on the generated library diffs to your PR if you change a template.

How does it work?

This workflow automatically creates all possible libraries from your branch, then it does the same from the main branch. Lastly, it compares the generated libraries and comments on the diffs.

Notes:

This PR also changes the install action to leverage yarn3's caching mechanisms.

github-actions · 2023-10-06T15:49:53Z

The diff

github-actions · 2023-10-06T17:38:07Z

The diff
diff -r --no-ignore-file-name-case old-version/android/src/main/java/com/bob/reactnativetest/ReactNativeTestModule.java new-version/android/src/main/java/com/bob/reactnativetest/ReactNativeTestModule.java
8a9

// Hi mom!
diff -r --no-ignore-file-name-case old-version/babel.config.js new-version/babel.config.js
1a2
// Hi mom!
diff -r --no-ignore-file-name-case old-version/package.json new-version/package.json
68c68
< "react-native-builder-bob": "^0.20.0",

"react-native-builder-bob": "^0.23.1",

github-actions · 2023-10-06T17:44:15Z

The diff

diff -r --no-ignore-file-name-case old-version/android/src/main/java/com/bob/reactnativetest/ReactNativeTestModule.java new-version/android/src/main/java/com/bob/reactnativetest/ReactNativeTestModule.java
8a9
> // Hi mom!
diff -r --no-ignore-file-name-case old-version/babel.config.js new-version/babel.config.js
1a2
>   // Hi mom!
diff -r --no-ignore-file-name-case old-version/package.json new-version/package.json
68c68
<     "react-native-builder-bob": "^0.20.0",
---
>     "react-native-builder-bob": "^0.23.1",

github-actions · 2023-10-06T17:59:33Z

This PR changes the output of create-react-native-library. You can find the diff of the change below:

diff -r -u --no-ignore-file-name-case old-version/android/src/main/java/com/bob/reactnativetest/ReactNativeTestModule.java new-version/android/src/main/java/com/bob/reactnativetest/ReactNativeTestModule.java
--- old-version/android/src/main/java/com/bob/reactnativetest/ReactNativeTestModule.java	2023-10-06 17:59:32.000000000 +0000
+++ new-version/android/src/main/java/com/bob/reactnativetest/ReactNativeTestModule.java	2023-10-06 17:59:26.000000000 +0000
@@ -6,6 +6,7 @@
 import com.facebook.react.bridge.ReactApplicationContext;
 import com.facebook.react.bridge.ReactMethod;
 
+// Hi mom!
 public class ReactNativeTestModule extends ReactNativeTestSpec {
   public static final String NAME = "ReactNativeTest";
 
diff -r -u --no-ignore-file-name-case old-version/babel.config.js new-version/babel.config.js
--- old-version/babel.config.js	2023-10-06 17:59:32.000000000 +0000
+++ new-version/babel.config.js	2023-10-06 17:59:26.000000000 +0000
@@ -1,3 +1,4 @@
 module.exports = {
+  // Hi mom!
   presets: ['module:metro-react-native-babel-preset'],
 };
diff -r -u --no-ignore-file-name-case old-version/package.json new-version/package.json
--- old-version/package.json	2023-10-06 17:59:32.000000000 +0000
+++ new-version/package.json	2023-10-06 17:59:26.000000000 +0000
@@ -65,7 +65,7 @@
     "prettier": "^2.0.5",
     "react": "17.0.2",
     "react-native": "0.70.0",
-    "react-native-builder-bob": "^0.23.1",
+    "react-native-builder-bob": "^0.20.0",
     "release-it": "^15.0.0",
     "typescript": "^5.0.2"
   },

This diff is between 975d1f7 and the main branch.

github-actions · 2023-10-06T17:59:54Z

The commit with hash: 2827e62 has changed the output of create-react-native-library. You can find the diff of the change below:

diff -r -u --no-ignore-file-name-case old-version/android/src/main/java/com/bob/reactnativetest/ReactNativeTestModule.java new-version/android/src/main/java/com/bob/reactnativetest/ReactNativeTestModule.java
--- old-version/android/src/main/java/com/bob/reactnativetest/ReactNativeTestModule.java	2023-10-06 17:59:53.000000000 +0000
+++ new-version/android/src/main/java/com/bob/reactnativetest/ReactNativeTestModule.java	2023-10-06 17:59:43.000000000 +0000
@@ -6,6 +6,7 @@
 import com.facebook.react.bridge.ReactApplicationContext;
 import com.facebook.react.bridge.ReactMethod;
 
+// Hi mom!
 public class ReactNativeTestModule extends ReactNativeTestSpec {
   public static final String NAME = "ReactNativeTest";
 
diff -r -u --no-ignore-file-name-case old-version/babel.config.js new-version/babel.config.js
--- old-version/babel.config.js	2023-10-06 17:59:53.000000000 +0000
+++ new-version/babel.config.js	2023-10-06 17:59:43.000000000 +0000
@@ -1,3 +1,4 @@
 module.exports = {
+  // Hi mom!
   presets: ['module:metro-react-native-babel-preset'],
 };

This diff is between this branch and the main branch.

github-actions · 2023-10-06T18:06:20Z

This PR changes the output of create-react-native-library. You can find the diff of the change below:

diff -r -u --no-ignore-file-name-case old-version/android/src/main/java/com/bob/reactnativetest/ReactNativeTestModule.java new-version/android/src/main/java/com/bob/reactnativetest/ReactNativeTestModule.java
--- old-version/android/src/main/java/com/bob/reactnativetest/ReactNativeTestModule.java	2023-10-06 18:06:19.000000000 +0000
+++ new-version/android/src/main/java/com/bob/reactnativetest/ReactNativeTestModule.java	2023-10-06 18:06:13.000000000 +0000
@@ -6,6 +6,7 @@
 import com.facebook.react.bridge.ReactApplicationContext;
 import com.facebook.react.bridge.ReactMethod;
 
+// Hi mom!
 public class ReactNativeTestModule extends ReactNativeTestSpec {
   public static final String NAME = "ReactNativeTest";
 
diff -r -u --no-ignore-file-name-case old-version/babel.config.js new-version/babel.config.js
--- old-version/babel.config.js	2023-10-06 18:06:19.000000000 +0000
+++ new-version/babel.config.js	2023-10-06 18:06:13.000000000 +0000
@@ -1,3 +1,4 @@
 module.exports = {
+  // Hi mom!
   presets: ['module:metro-react-native-babel-preset'],
 };

This diff is between 69b58ba9fced328a3e141a38c8c95377c1531baa and the main branch.

github-actions · 2023-10-06T18:15:35Z

This PR changes the output of create-react-native-library. You can find the diff of the change below:

diff -r -u --no-ignore-file-name-case old-version/android/src/main/java/com/bob/reactnativetest/ReactNativeTestModule.java new-version/android/src/main/java/com/bob/reactnativetest/ReactNativeTestModule.java
--- old-version/android/src/main/java/com/bob/reactnativetest/ReactNativeTestModule.java	2023-10-06 18:15:34.000000000 +0000
+++ new-version/android/src/main/java/com/bob/reactnativetest/ReactNativeTestModule.java	2023-10-06 18:15:28.000000000 +0000
@@ -6,6 +6,7 @@
 import com.facebook.react.bridge.ReactApplicationContext;
 import com.facebook.react.bridge.ReactMethod;
 
+// Hi mom!
 public class ReactNativeTestModule extends ReactNativeTestSpec {
   public static final String NAME = "ReactNativeTest";
 
diff -r -u --no-ignore-file-name-case old-version/babel.config.js new-version/babel.config.js
--- old-version/babel.config.js	2023-10-06 18:15:34.000000000 +0000
+++ new-version/babel.config.js	2023-10-06 18:15:28.000000000 +0000
@@ -1,3 +1,4 @@
 module.exports = {
+  // Hi mom!
   presets: ['module:metro-react-native-babel-preset'],
 };
diff -r -u --no-ignore-file-name-case old-version/package.json new-version/package.json
--- old-version/package.json	2023-10-06 18:15:34.000000000 +0000
+++ new-version/package.json	2023-10-06 18:15:28.000000000 +0000
@@ -65,7 +65,7 @@
     "prettier": "^2.0.5",
     "react": "17.0.2",
     "react-native": "0.70.0",
-    "react-native-builder-bob": "^0.23.1",
+    "react-native-builder-bob": "^0.20.0",
     "release-it": "^15.0.0",
     "typescript": "^5.0.2"
   },

This diff is between bf4e03bcae26d9357a3c285831d0ef17266d3f78 and the main branch.

github-actions · 2023-10-06T18:22:12Z

This PR changes the output of create-react-native-library. You can find the diff of the change below:

diff -r -u --no-ignore-file-name-case old-version/android/src/main/java/com/bob/reactnativetest/ReactNativeTestModule.java new-version/android/src/main/java/com/bob/reactnativetest/ReactNativeTestModule.java
--- old-version/android/src/main/java/com/bob/reactnativetest/ReactNativeTestModule.java	2023-10-06 18:22:10.000000000 +0000
+++ new-version/android/src/main/java/com/bob/reactnativetest/ReactNativeTestModule.java	2023-10-06 18:22:04.000000000 +0000
@@ -6,6 +6,7 @@
 import com.facebook.react.bridge.ReactApplicationContext;
 import com.facebook.react.bridge.ReactMethod;
 
+// Hi mom!
 public class ReactNativeTestModule extends ReactNativeTestSpec {
   public static final String NAME = "ReactNativeTest";
 
diff -r -u --no-ignore-file-name-case old-version/babel.config.js new-version/babel.config.js
--- old-version/babel.config.js	2023-10-06 18:22:10.000000000 +0000
+++ new-version/babel.config.js	2023-10-06 18:22:04.000000000 +0000
@@ -1,3 +1,4 @@
 module.exports = {
+  // Hi mom!
   presets: ['module:metro-react-native-babel-preset'],
 };
diff -r -u --no-ignore-file-name-case old-version/package.json new-version/package.json
--- old-version/package.json	2023-10-06 18:22:10.000000000 +0000
+++ new-version/package.json	2023-10-06 18:22:04.000000000 +0000
@@ -65,7 +65,7 @@
     "prettier": "^2.0.5",
     "react": "17.0.2",
     "react-native": "0.70.0",
-    "react-native-builder-bob": "^0.20.0",
+    "react-native-builder-bob": "^0.23.1",
     "release-it": "^15.0.0",
     "typescript": "^5.0.2"
   },

github-actions · 2023-10-06T18:48:52Z

This PR changes the output of create-react-native-library. You can find the diff of the change below:

diff -r -u --no-ignore-file-name-case old-version/android/src/main/java/com/bob/reactnativetest/ReactNativeTestModule.java new-version/android/src/main/java/com/bob/reactnativetest/ReactNativeTestModule.java
--- old-version/android/src/main/java/com/bob/reactnativetest/ReactNativeTestModule.java
+++ new-version/android/src/main/java/com/bob/reactnativetest/ReactNativeTestModule.java
@@ -6,6 +6,7 @@
 import com.facebook.react.bridge.ReactApplicationContext;
 import com.facebook.react.bridge.ReactMethod;
 
+// Hi mom!
 public class ReactNativeTestModule extends ReactNativeTestSpec {
   public static final String NAME = "ReactNativeTest";
 
diff -r -u --no-ignore-file-name-case old-version/babel.config.js new-version/babel.config.js
--- old-version/babel.config.js
+++ new-version/babel.config.js
@@ -1,3 +1,4 @@
 module.exports = {
+  // Hi mom!
   presets: ['module:metro-react-native-babel-preset'],
 };

This reverts commit 1366168.

This reverts commit d3d14c7.

satya164 · 2023-11-06T13:46:34Z

.github/workflows/comment-diffs.yml

@@ -0,0 +1,306 @@
+name: Comment template diffs
+on:
+  workflow_dispatch:


you can remove this - it doesn't make sense for commenting diff

satya164 · 2023-11-06T13:49:13Z

.github/workflows/comment-diffs.yml

+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version-file: .nvmrc


this should already be handled by the next job

satya164 · 2023-11-06T13:53:24Z

.github/workflows/comment-diffs.yml

+
+      - name: Remove old build and build again
+        run: |
+          rm -rf ./packages/create-react-native-library/lib


running prepare already deletes this folder due to --delete-dir-on-start

satya164 · 2023-11-06T13:54:18Z

.github/workflows/comment-diffs.yml

+          git fetch origin main
+          git checkout origin/main
+          git pull || true


Shouldn't this happen BEFORE installing dependencies and building the library?

satya164 · 2023-11-06T13:55:13Z

.github/workflows/configMatrix.sh

@@ -0,0 +1,30 @@
+#!/bin/bash


let's move this to scripts/ at root. i'm not a fan of files that are not workflows inside the workflows folder

also use snake-case for bash scripts

satya164 · 2023-11-06T13:57:43Z

.github/workflows/comment-diffs.yml

+          create_library() {
+            library_type=$1
+            language=$2
+
+            echo "Running $library_type/$language"
+            path_prefix="../test/$library_type/$language"
+            target_path="$path_prefix/old-version"
+
+            npx create-react-native-library "$target_path" \
+              --slug @bob/react-native-test \
+              --description test \
+              --author-name test \
+              --author-email test@test \
+              --author-url https://test.test \
+              --repo-url https://test.test \
+              --type "$library_type" \
+              --languages "$language" \
+              --no-example \
+              --no-local
+
+            # Remove the .git folder of the created library
+            rm -rf "$target_path/.git"
+          }
+
+          for library_type in "${libraryTypes[@]}"; do
+            for language in "${languages[@]}"; do
+              if [[ ! "${exclude[*]}" =~ ${library_type}/${language} ]]; then
+                create_library "$library_type" "$language"
+              fi
+            done
+          done


this code is the same as before right? in that case maybe you can move this whole thing to the script instead of only having matrix to reduce duplication, or 2 scripts? and pass the folder name to the script which seems to be the only difference

satya164 · 2023-11-06T13:58:26Z

.github/workflows/comment-diffs.yml

+          for library_type in "${libraryTypes[@]}"; do
+            for language in "${languages[@]}"; do
+              if [[ ! "${exclude[*]}" =~ ${library_type}/${language} ]]; then
+                create_library "$library_type" "$language"
+              fi
+            done
+          done


maybe JS script would be better for readability instead of bash

satya164 · 2023-11-06T13:59:43Z

.github/workflows/comment-diffs.yml

+          done
+
+      - name: Remove everything in the working directory
+        run: for i in $(ls) ; do rm -rf "$i"; done;


is the loop needed? rm -r * .* should do the job as well, right?

satya164 · 2023-11-06T14:04:43Z

.github/workflows/comment-diffs.yml

+            const replaceTable = {
+              "module-legacy": "Native module",
+              "module-mixed": "Turbo module with backward compat",
+              "module-new": "Turbo module",
+              "view-legacy": "Native view",
+              "view-mixed": "Fabric view with backward compat",
+              "view-new": "Fabric view",
+              "java-objc": "Java and Objective C",
+              "java-swift": "Java and Swift",
+              "kotlin-objc": "Kotlin and Objective C",
+              "kotlin-swift": "Kotlin and Swift",
+              ".txt": ""
+            }


having the matrix in JSON would be nice, since this table could also be colocated.

though maybe we should add a command to create-react-native-library, create-react-native-library --list-types and create-react-native-library --list-languages or something that lists all available templates instead hardcoding. then we could use that for matrix in build-templates as well as here. i have forgotten to change the matrix when i change templates in past (worse when something gets added and there's no test failure), and it'll avoid this.

satya164 · 2023-11-06T14:05:31Z

.github/workflows/comment-diffs.yml

+              const [type, language] = fileName.split("+");
+
+              const title = Object.entries(replaceTable).reduce((acc, [key, value]) => {
+                return acc.replace(new RegExp(key, "g"), value);


wouldn't return acc.replace(key, value); work here?

atlj added 21 commits October 15, 2023 16:58

chore: remove all actions and add new action for commenting diffs

f3a7127

chore: dummy change

50578b4

chore: add diff commenting CI

4646a40

chore: use macos runner

446c798

chore: use origin/main

81f08de

chore: add fetch before checkout

12a5675

chore: disable setup again for testing

727a5ff

chore: comment diff

e3962a5

chore: fix string

59bdf13

chore: remove url from action

4aa22eb

chore: add no example

05d5b98

chore: fix names

1d55b2f

chore: add continue on error

d65b373

chore: fix diff parms

ced5523

chore: add || true

6d3e11f

chore: print diff

42fab43

chore: customize a file for diff

c780129

chore: ls

48430ea

chore: add pipe operator

ddd736c

chore: add no ignore file case

861faf6

chore: add delimeter

2f28d65

atlj added 21 commits October 15, 2023 16:58

chore: change stuff

6647039

chore: fix

e2a0ece

chore: debug

a7f737a

chore: quiet

feb1ecb

chore: use +

efcb3c2

chore: test

3a059b7

chore: test

35dbfe9

chore: join string

effaada

chore: fix

1bb4547

chore: change order

64fa7c2

chore: add condition to install again

de2b97b

chore: add leftpad to tset

f361d84

chore: disable some of the caching

c24360d

chore: always install

e01ee62

chore: run yarn install at second time

a477ad4

chore: cleanup

4e0628f

chore: remove some changes

74b4abf

Revert "chore: add leftpad to tset"

0ac7337

This reverts commit 1366168.

chore: improvements

c7e923a

chore: add temporarely

5b1e84e

chore: use rn 0.73.0 rc on build templates workflow

d3d14c7

atlj force-pushed the @atlj/diff-commentor branch from 37e61e9 to d3d14c7 Compare October 15, 2023 13:59

atlj changed the title ~~[WIP] chore: comment diffs automatically~~ chore: comment diffs automatically Oct 15, 2023

atlj requested a review from satya164 October 15, 2023 14:04

atlj added 4 commits October 15, 2023 17:08

Revert "chore: use rn 0.73.0 rc on build templates workflow"

8016ada

This reverts commit d3d14c7.

chore: fix typo

3d58cf5

chore: use the old install action

0038348

chore: improve readability

73a3a35

atlj force-pushed the @atlj/diff-commentor branch from 739cfe3 to 73a3a35 Compare October 27, 2023 14:37

satya164 reviewed Nov 6, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: comment diffs automatically #478

chore: comment diffs automatically #478

atlj commented Oct 6, 2023 •

edited

github-actions bot commented Oct 6, 2023

github-actions bot commented Oct 6, 2023

github-actions bot commented Oct 6, 2023

github-actions bot commented Oct 6, 2023

github-actions bot commented Oct 6, 2023

github-actions bot commented Oct 6, 2023

github-actions bot commented Oct 6, 2023

github-actions bot commented Oct 6, 2023

github-actions bot commented Oct 6, 2023

satya164 Nov 6, 2023

satya164 Nov 6, 2023

satya164 Nov 6, 2023

satya164 Nov 6, 2023

satya164 Nov 6, 2023

satya164 Nov 6, 2023

satya164 Nov 6, 2023

satya164 Nov 6, 2023

satya164 Nov 6, 2023

satya164 Nov 6, 2023

chore: comment diffs automatically #478

Are you sure you want to change the base?

chore: comment diffs automatically #478

Conversation

atlj commented Oct 6, 2023 • edited

Summary:

How does it work?

Notes:

github-actions bot commented Oct 6, 2023

github-actions bot commented Oct 6, 2023

github-actions bot commented Oct 6, 2023

github-actions bot commented Oct 6, 2023

github-actions bot commented Oct 6, 2023

github-actions bot commented Oct 6, 2023

github-actions bot commented Oct 6, 2023

github-actions bot commented Oct 6, 2023

github-actions bot commented Oct 6, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

atlj commented Oct 6, 2023 •

edited