an implementation of the init command #293

hathibelagal-dev · 2020-12-11T05:37:56Z

Fixes #193

hathibelagal-dev · 2020-12-11T05:55:44Z

Added the init command, a test for it, and updated the README.

jakemac53 · 2020-12-11T16:22:49Z

mono_repo/lib/src/commands/init.dart

+    final repoCfgPath = p.join(rootDir, _repoCfgFileName);
+    if (!File(repoCfgPath).existsSync()) {
+      File(repoCfgPath).writeAsStringSync(_commentText);
+      print('Added $_repoCfgFileName to $rootDir');


We might want to bold these? We use the package:io/ansi.dart library for this, so for example this would become:

print(styleBold.wrap('Added $_repoCfgFileName to $rootDir'))

jakemac53 · 2020-12-11T16:23:08Z

mono_repo/lib/src/commands/init.dart

+      File(repoCfgPath).writeAsStringSync(_commentText);
+      print('Added $_repoCfgFileName to $rootDir');
+    } else {
+      print('$_repoCfgFileName already present in $rootDir. Exiting...');


Similarly this should likely be red, or maybe yellow

jakemac53 · 2020-12-11T16:30:16Z

mono_repo/lib/src/commands/init.dart

+    final pubspecPath = p.join(currentDir, _pubspecFileName);
+
+    if (!File(pubspecPath).existsSync()) {
+      final pubspecContents = 'name: ${p.basename(currentDir)}\n';


I think I am not completely opposed to this part, but I wasn't originally assuming this would create any packages for you (it would assume the packages exist and just create mono repo files).

I can see value in both options though, and this does allow for the bootstrapping existing packages case still so 🤷

jakemac53 · 2020-12-11T16:41:27Z

mono_repo/lib/src/commands/init.dart

+  String get description => 'Scaffold a new mono repo.';
+
+  @override
+  void run() => scaffold(p.current, globalResults[_recursiveScanFlag] as bool);


This command should use its own arg parser and then use argResults here - see the generatecommand for an example. Then we can set the default as well (it should be false, imo).

jakemac53 · 2020-12-11T16:51:07Z

mono_repo/lib/src/commands/init.dart

+    }
+
+    if (!File(pkgCfgPath).existsSync()) {
+      File(pkgCfgPath).writeAsStringSync(_commentText);


I think for the package config, it would be good to initialize this with some default settings.

For instance running dartanalyzer, dartfmt and pub run test, something like this:

dart: - dev - stable os: - linux stages: - analyze_and_format: - dartanalyzer: --fatal-infos --fatal-warnings . - dartfmt: sdk - unit_test: - test:

jakemac53 · 2020-12-11T16:52:28Z

mono_repo/lib/src/commands/init.dart

+  if (currentDir == rootDir) {
+    final repoCfgPath = p.join(rootDir, _repoCfgFileName);
+    if (!File(repoCfgPath).existsSync()) {
+      File(repoCfgPath).writeAsStringSync(_commentText);


I think for this one we should default to enabling github actions.

It might also be nice to plop in some other common settings such as a cron job and webhook notifications for failed jobs on master?

jakemac53 · 2020-12-11T16:52:34Z

mono_repo/lib/src/commands/init.dart

+
+  final subdirs =
+      Directory(currentDir).listSync().whereType<Directory>().toList();
+  for (var subdir in subdirs) {


I am a bit on the fence about this behavior - especially in the case of pre-existing packages we wouldn't want to go creating a whole bunch of pubspecs in all nested packages.

I am somewhat inclined to just not support this for the init command at all - or we could remove the behavior that creates a new package in all directories where a pubspec did not exist before.

If we add the mono_pkg.yaml only to directories that already have a pubspec.yaml, we're assuming the user is never starting from scratch.

And I was initially adding the mono_pkg.yaml file only to the immediate subdirectories of root. But directory structures such as root/pkgs/package1,package2 are common too, so doing it recursively seemed to make more sense. But this would add the files in the pkgs directory too, which would be wrong.

I think it would be safest to add the mono_pkg.yaml only to directories that have a pubspec.yaml.

hathibelagal-dev · 2020-12-11T20:48:42Z

Now that I'm only adding mono_pkg.yaml to directories that have a pubspec.yaml, do I still need to use the arg parser? Wouldn't the default recursive setting be acceptable now?

jakemac53 · 2020-12-17T18:23:30Z

Missed your updates here somehow sorry - taking a look

jakemac53 · 2020-12-17T18:31:49Z

Now that I'm only adding mono_pkg.yaml to directories that have a pubspec.yaml, do I still need to use the arg parser? Wouldn't the default recursive setting be acceptable now?

The usage of the global config and not arg parser is weird, but it looks like the base MonoRepo class is doing this already so what you have is probably fine (its at least consistent, maybe we should clean it all up later).

I think you do need to add a default in when reading it though (or add recursive ??= false to the top of the configureDirectory method).

jakemac53 · 2020-12-17T18:38:05Z

mono_repo/lib/src/commands/init.dart

+      if: (github.event_name == 'push' || github.event_name == 'schedule') && failure()
+      steps:
+        - run: >
+            curl -H "Content-Type: application/json" -X POST -d \
+              "{'text':'Build failed! ${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}/actions/runs/${GITHUB_RUN_ID}'}" \
+              "${CHAT_WEBHOOK_URL}"
+          env:
+            CHAT_WEBHOOK_URL: ${{ secrets.BUILD_AND_TEST_TEAM_CHAT_WEBHOOK_URL }}


This section should be commented out, as it won't work without some repo level configuration and it is also specific to the expected payload for google chat webhooks and won't work for slack, etc.

Suggested change

if: (github.event_name == 'push' || github.event_name == 'schedule') && failure()

steps:

- run: >

curl -H "Content-Type: application/json" -X POST -d \

"{'text':'Build failed! ${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}/actions/runs/${GITHUB_RUN_ID}'}" \

"${CHAT_WEBHOOK_URL}"

env:

CHAT_WEBHOOK_URL: ${{ secrets.BUILD_AND_TEST_TEAM_CHAT_WEBHOOK_URL }}

# if: (github.event_name == 'push' || github.event_name == 'schedule') && failure()

# steps:

# - run: >

# curl -H "Content-Type: application/json" -X POST -d \

# # Note that this is specific to google chat webhook format - other services expect

# # a different looking JSON payload.

# "{'text':'Build failed! ${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}/actions/runs/${GITHUB_RUN_ID}'}" \

# "${CHAT_WEBHOOK_URL}"

# env:

# CHAT_WEBHOOK_URL: ${{ secrets.<your-github-secret-id> }}

jakemac53 · 2020-12-17T18:39:28Z

mono_repo/lib/src/commands/init.dart

+          env:
+            CHAT_WEBHOOK_URL: ${{ secrets.BUILD_AND_TEST_TEAM_CHAT_WEBHOOK_URL }}
+
+merge_stages:


Suggested change

merge_stages:

# Merges all tasks from this stage across all packages into a single job, where possible.

# This speeds up CI runs when you have lots of very small tasks.

merge_stages:

jakemac53 · 2020-12-17T18:40:32Z

@kevmoo did you have thoughts here?

kevmoo · 2020-12-17T18:50:46Z

@kevmoo did you have thoughts here?

...if you're happy... 😄

hathibelagal-dev added 2 commits December 11, 2020 00:36

an implementation of the init command

270e15d

Updated README to show the new init command

7f2defd

Made some constants private

b4d8b7e

jakemac53 reviewed Dec 11, 2020

View reviewed changes

hathibelagal-dev added 2 commits December 11, 2020 15:41

Only add mono_pkg.yaml to directories that have a pubspec.yaml

9e98a69

Removed unused imports

151bdc5

More lint changes

6841788

jakemac53 reviewed Dec 17, 2020

View reviewed changes

hathibelagal-dev closed this Dec 26, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

an implementation of the init command #293

an implementation of the init command #293

hathibelagal-dev commented Dec 11, 2020

hathibelagal-dev commented Dec 11, 2020

jakemac53 Dec 11, 2020

jakemac53 Dec 11, 2020

jakemac53 Dec 11, 2020

jakemac53 Dec 11, 2020

jakemac53 Dec 11, 2020

jakemac53 Dec 11, 2020

jakemac53 Dec 11, 2020

hathibelagal-dev Dec 11, 2020 •

edited

Loading

hathibelagal-dev Dec 11, 2020

hathibelagal-dev commented Dec 11, 2020

jakemac53 commented Dec 17, 2020

jakemac53 commented Dec 17, 2020

jakemac53 Dec 17, 2020 •

edited

Loading

jakemac53 Dec 17, 2020

jakemac53 commented Dec 17, 2020

kevmoo commented Dec 17, 2020

-      if: (github.event_name == 'push' || github.event_name == 'schedule') && failure()
-      steps:
-        - run: >
-            curl -H "Content-Type: application/json" -X POST -d \
-              "{'text':'Build failed! ${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}/actions/runs/${GITHUB_RUN_ID}'}" \
-              "${CHAT_WEBHOOK_URL}"
-          env:
-            CHAT_WEBHOOK_URL: ${{ secrets.BUILD_AND_TEST_TEAM_CHAT_WEBHOOK_URL }}
+      # if: (github.event_name == 'push' || github.event_name == 'schedule') && failure()
+      # steps:
+      #   - run: >
+      #       curl -H "Content-Type: application/json" -X POST -d \
+      #       # Note that this is specific to google chat webhook format - other services expect
+      #       # a different looking JSON payload.
+      #         "{'text':'Build failed! ${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}/actions/runs/${GITHUB_RUN_ID}'}" \
+      #         "${CHAT_WEBHOOK_URL}"
+      #     env:
+      #       CHAT_WEBHOOK_URL: ${{ secrets.<your-github-secret-id> }}

an implementation of the init command #293

an implementation of the init command #293

Conversation

hathibelagal-dev commented Dec 11, 2020

hathibelagal-dev commented Dec 11, 2020

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

hathibelagal-dev Dec 11, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hathibelagal-dev commented Dec 11, 2020

jakemac53 commented Dec 17, 2020

jakemac53 commented Dec 17, 2020

jakemac53 Dec 17, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jakemac53 commented Dec 17, 2020

kevmoo commented Dec 17, 2020

hathibelagal-dev Dec 11, 2020 •

edited

Loading

jakemac53 Dec 17, 2020 •

edited

Loading