Merge pull request #146 from Shopify/bring-dist-back-to-main

Bring dist back to main

.github/workflows/ensure_dist_committed.yml

@@ -0,0 +1,51 @@
+name: Ensure distribution files committed are up-to-date
+
+on:
+  pull_request:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  ensure_dist_committed:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+
+    - name: Install Cue
+      uses: cue-lang/setup-cue@v1.0.0
+      with:
+        version: 'v0.7.0'
+
+    - name: Install bundler and gems
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+
+    - name: Generate distribution files
+      run: make
+
+    - name: Ensure there are no uncommitted distrubtion file changes
+      id: ensure-dist-committed
+      run: |
+        git diff --exit-code || (echo "Please commit the changes made by the build process" && exit 1)
+
+    - name: Inform PR author of failure and path to fix
+      if: ${{ failure() && steps.ensure-dist-committed.outcome == 'failure' }}
+      run: |
+        # Comment to send
+        COMMENT="Hi there! It looks like your pull request changes taxonomy \`data/*\` files, but is missing updates to \`dist/*\` files.<br /><br />**⏭️ How to fix**<br />Make a PR comment of \`/generate_dist\`, and I will fix this for you :robot:. Alternatively, you can run \`make\` locally and commit the changes yourself."
+
+        # GitHub API Token and PR URL
+        GITHUB_TOKEN=${{ secrets.GITHUB_TOKEN }}
+        COMMENT_URL="https://api.github.com/repos/${{ github.repository }}/issues/${{ github.event.pull_request.number }}/comments"
+
+        # Use jq to encode the JSON properly, carefully handling the new lines and backticks
+        JSON_BODY=$(jq -n --arg body "$COMMENT" '{body: $body}')
+
+        # Use curl to post the comment.
+        curl -s -H "Authorization: token ${GITHUB_TOKEN}" -X POST "$COMMENT_URL" -d "$JSON_BODY"

.github/workflows/generate_dist.yml

@@ -17,8 +17,11 @@ jobs:
     runs-on: ubuntu-latest
     if: ${{ github.event.issue.pull_request && github.event.comment.body == '/generate_dist' }}
     steps:
-    - name: Checkout code
-      uses: actions/checkout@v4
+    - name: Checkout PR
+      run: gh pr checkout $ISSUE
+      env:
+        GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        ISSUE: ${{ github.event.issue.html_url }}
 
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
@@ -38,8 +41,8 @@ jobs:
 
     - name: Commit distribution files
       run: |
-        git config --global user.name "github-actions[bot]"
-        git config --global user.email "github-actions[bot]@users.noreply.github.com"
+        git config --local user.name "GitHub Action"
+        git config --local user.email "action@github.com"
         git add dist
-        git commit -m "🤖 Update distribution files"
+        git commit -m "🤖 Update distribution files" || exit 0 # Exit gracefully if no changes
         git push

.github/workflows/ci.yml → .github/workflows/tests.yml

@@ -7,6 +7,7 @@ on:
   pull_request:
     branches:
       - main
+  workflow_dispatch:
 
 jobs:
   test:

.gitignore

@@ -12,6 +12,4 @@ schema/mappings_data.cue
 .byebug_history
 
 # generated dist files
-/dist/*
-!/dist/README.md
-!/dist/img/
+/dist/CHANGELOG.md

Makefile

@@ -44,9 +44,6 @@ DIST_GENERATED_SENTINEL = tmp/.dist_generated_sentinel
 CATEGORIES_JSON = $(GENERATED_DIST_PATH)/categories.json
 ATTRIBUTES_JSON = $(GENERATED_DIST_PATH)/attributes.json
 MAPPINGS_JSON = $(GENERATED_DIST_PATH)/mappings.json
-STATIC_VERSION_FILE = $(GENERATED_DIST_PATH)/VERSION
-STATIC_LICENSE_FILE = $(GENERATED_DIST_PATH)/LICENSE
-STATIC_CHANGELOG_FILE = $(GENERATED_DIST_PATH)/CHANGELOG.md
 
 # DATA files to run application
 LOCAL_DB = tmp/local.sqlite3
@@ -65,9 +62,6 @@ default: build
 .PHONY: default
 
 build: $(DIST_GENERATED_SENTINEL) \
-	$(STATIC_VERSION_FILE) \
-	$(STATIC_LICENSE_FILE) \
-	$(STATIC_CHANGELOG_FILE) \
 	$(DOCS_GENERATED_SENTINEL) \
 	$(CATEGORIES_DATA_CUE) \
 	$(ATTRIBUTES_DATA_CUE) \
@@ -84,18 +78,6 @@ $(DIST_GENERATED_SENTINEL): $(LOCAL_DB) $(CATEGORIES_DATA) $(ATTRIBUTES_DATA) $(
 	$(V)bin/generate_dist $(VARG)
 	$(V)touch $@
 
-$(STATIC_VERSION_FILE):
-	@$(GENERATE) "Copying Version File" $(STATIC_VERSION_FILE)
-	$(V)cp -f VERSION $(STATIC_VERSION_FILE)
-
-$(STATIC_LICENSE_FILE):
-	@$(GENERATE) "Copying License File" $(STATIC_LICENSE_FILE)
-	$(V)cp -f LICENSE $(STATIC_LICENSE_FILE)
-
-$(STATIC_CHANGELOG_FILE):
-	@$(GENERATE) "Copying Changelog File" $(STATIC_CHANGELOG_FILE)
-	$(V)cp -f CHANGELOG.md $(STATIC_CHANGELOG_FILE)
-
 #
 # RELEASE
 release: build
@@ -119,9 +101,6 @@ clean:
 	$(V)rm -f $(MAPPINGS_DATA_CUE)
 	@$(NUKE) "Cleaning Generated Dist Files" $(GENERATED_DIST_PATH)
 	$(V)rm -f $(DIST_GENERATED_SENTINEL)
-	$(V)rm -f $(STATIC_VERSION_FILE)
-	$(V)rm -f $(STATIC_LICENSE_FILE)
-	$(V)rm -f $(STATIC_CHANGELOG_FILE)
 	$(V)rm -rf $(GENERATED_DIST_PATH)/*.json
 	$(V)rm -rf $(GENERATED_DIST_PATH)/*.txt
 .PHONY: clean