chore: consolidate the build by junglebarry · Pull Request #52 · talis/bootstrap-theme

junglebarry · 2025-06-25T15:21:59Z

Problem

A CircleCI build has been defined... but it doesn't seem to run correctly or be included in the branch protection rules.

Change/Fix

Run the steps defined in the build... plus npm run build to be sure it is run before merge and give a bit more safety. Adds branch-protection that ensure the build runs before merge:

junglebarry · 2025-06-25T16:56:59Z

  build-and-test:
    jobs:
-      - start:
-          name: Start


The names just confuse matters, which is why the build hasn't been running. Removed, accordingly.

... nope. The names confused me; but the build hasn't been running because the branch protection doesn't make it obvious they need to. In any case, I've aligned these with conventions elsewhere.

junglebarry · 2025-06-25T16:57:21Z

+  start_build:
+    type: no-op
+
+  complete_build:
+    type: no-op


Use no-op types to spare us the credits and the extra seconds.

junglebarry · 2025-06-25T16:58:23Z

-          command: npm run build:eleventy
+          command: npm run build


We should have been building the CSS as well as the eleventy files - build does both.

junglebarry · 2025-06-25T16:58:37Z

+      - run:
+          name: "Build"
+          command: npm run build


We also want to know that the docs build correctly.

I am a bit puzzled at this point about what should and should not be built, but we want to ensure it doesn't fail in branch builds before merging into main. As follow-ups, I'll work towards either:

Checking that any generated artifacts that must be under version control are indeed updated (i.e. a porcelain check)

Excluding any truly generated artifacts from version control, if possible.

I can't really tell which it needs to be, yet, but will see once a few builds go through.

So from what I understand currently the build files are committed and nothing is actually in gitignore . not sure why it was done this way, it could be because its using eleventry and its hosted in github-pages ! so to keep the deployment simple we might want to keep as is but maybe we should be ok to ignore .map files as they are just debug artifacts!
For the check, I wonder if we can have another step in circleCI to do git diff between what came out after the build to whats been committed in the code source!

So from what I understand currently the build files are committed and nothing is actually in gitignore . not sure why it was done this way, it could be because its using eleventry and its hosted in github-pages ! so to keep the deployment simple we might want to keep as is but maybe we should be ok to ignore .map files as they are just debug artifacts! For the check, I wonder if we can have another step in circleCI to do git diff between what came out after the build to whats been committed in the code source!

Yes - that's the first option - a porcelain check.

junglebarry · 2025-06-25T16:58:58Z

            branches:
              only:
                - main
+      - complete_build:


A fan-in step, to simplify the branch protection statuses

... note that this is not a no-op because those do not report statuses back to Github, and we need to use the status report in the branch protection rules.

junglebarry · 2025-06-25T17:00:05Z

  "scripts": {
    "build": "npm-run-all build:*",
-    "build:css": "sass scss/:docs/assets/css/ --style=compressed --load-path=node_modules --source-map",
+    "build:css": "npm run css-compile",


Broken window: The definitions are the same, so compose rather than duplicating.

junglebarry · 2025-06-25T17:00:16Z

    "server": "serve docs --listen 3000",
    "start": "npm-run-all --parallel build:css watch:*",
-    "test": "npm run css-lint && npm run css",
+    "test": "npm-run-all css-lint css",


Broken window: use the tools.

junglebarry · 2025-06-25T17:00:39Z

    "watch": "nodemon -e html,scss -x \"npm run css\"",
    "watch:eleventy": "eleventy --serve",
-    "watch:sass": "sass scss/:docs/assets/css/ --style=compressed --load-path=node_modules --source-map --watch"
+    "watch:sass": "npm run css-compile -- --watch"


Broken window: Again, except for --watch this is the same as css-compile - use it via composition instead.

junglebarry · 2025-06-25T17:00:59Z

-  start:
-    <<: *executor_node
-    steps:
-      - run:
-          name: Start
-          command: |
-            echo Start
+  start_build:
+    type: no-op


Simpler fan-out.

junglebarry · 2025-06-25T17:01:08Z

            - node_modules
          key: << pipeline.parameters.node_modules_cache_key >>
-  
+


Broken window: spacing.

junglebarry · 2025-06-25T17:03:14Z

-            - Start
-            - Be kind to your colleagues
+            - start_build
+            - be_kind_to_your_colleagues


I think these names were the reason the build never ran.

junglebarry · 2025-06-26T08:28:35Z

+  start_build:
+    type: no-op


Changed to no-op for efficiency.

junglebarry · 2025-06-26T08:29:21Z

+  start_build:
+    type: no-op
+
+  complete_build:


This cannot be no-op because CircleCI does not report statuses to Github status checks for no-ops. We add branch protection against this job.

junglebarry force-pushed the fix_build branch 3 times, most recently from bb56875 to 152edb9 Compare June 25, 2025 16:58

junglebarry commented Jun 25, 2025

View reviewed changes

chore: consolidate the build

a3778bf

junglebarry force-pushed the fix_build branch from c2be170 to a3778bf Compare June 25, 2025 17:13

junglebarry commented Jun 26, 2025

View reviewed changes

Crevitus approved these changes Jun 26, 2025

View reviewed changes

mike-dean-talis approved these changes Jun 26, 2025

View reviewed changes

junglebarry merged commit a1ae371 into main Jun 26, 2025
2 checks passed

junglebarry deleted the fix_build branch June 26, 2025 09:12

		- node_modules
		key: << pipeline.parameters.node_modules_cache_key >>

Conversation

junglebarry commented Jun 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Problem

Change/Fix

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

junglebarry Jun 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

junglebarry Jun 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

junglebarry Jun 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

junglebarry commented Jun 25, 2025 •

edited

Loading

junglebarry Jun 25, 2025 •

edited

Loading

junglebarry Jun 25, 2025 •

edited

Loading

junglebarry Jun 25, 2025 •

edited

Loading