Revert "Issue #29" by Kampi · Pull Request #31 · Kampi/ESP32-Lepton

Kampi · 2026-01-27T13:18:04Z

Reverts #30

Summary by CodeRabbit

Release Notes

New Features
- Automated nightly releases now available for testing latest updates.
Chores
- Updated changelog location to hardware directory.
- Enhanced CI/CD workflow automation and branch management.
- Removed internal development guidelines.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

This reverts commit 25ed4b9.

coderabbitai · 2026-01-27T13:18:25Z

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

This PR removes comprehensive Copilot guidelines and restructures GitHub Actions workflows: relocating the changelog to the hardware directory, adding master_branch environment variables, adjusting trigger conditions with path filters, expanding release automation to include nightly releases with tarball generation, and simplifying version extraction logic.

Changes

Cohort / File(s)	Summary
Configuration & Documentation Removal `.github/copilot-instructions.md`	Deleted 502-line Copilot guidelines file including project overview, code style, naming conventions, and best practices documentation.
Workflow Environment Configuration `.github/workflows/astyle.yaml`	Added `env.master_branch: master` variable for branch indicator use within the workflow.
Changelog Path Migration `.github/workflows/changelog-check.yaml`	Migrated changelog references from repository root (CHANGELOG.md) to hardware/CHANGELOG.md; updated file path checks, validation logic, and error messages; added `env.master_branch: main`; adjusted push and pull_request triggers to filter by hardware/CHANGELOG.md path.
Release Automation & Documentation Deployment `.github/workflows/documentation.yaml`	Added path filters for docs/** to push trigger; introduced `env.master_branch: main`; broadened deploy condition to include tag-based releases; renamed deploy job and reworked to create nightly release tarball and upload artifacts to GitHub Releases; kept GitHub Pages deployment intact.
Release Version Extraction Simplification `.github/workflows/release.yaml`	Consolidated branch name extraction to single sed pattern, removing dual-format handling; simplified fallback logic for version extraction from commit message; reworked changelog updates to rely on extracted VERSION; removed explicit git tag creation step.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

Release 0.0.2 #22: Modifies release.yaml workflow to alter release version extraction and release artifact production methods.
Release 0.0.2 #17: Updates release.yaml with overlapping changes to branch name/version extraction and changelog update logic.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

Copilot

Pull request overview

This pull request reverts PR #30 (Issue #29), rolling back changes that were made to GitHub Actions workflows and removing Copilot instructions. The revert affects release automation, documentation building, changelog validation, and code style checking workflows.

Changes:

Reverts version extraction logic simplifications in release workflow
Removes "Create and push tag" step from release workflow
Changes changelog validation to look for file in hardware/ subdirectory
Adds path filters and nightly release functionality to documentation workflow
Removes GitHub Copilot instructions file
Adds environment variable definitions across multiple workflows

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 9 comments.

Show a summary per file

File	Description
.github/workflows/release.yaml	Reverts simplifications to version extraction logic, removes explicit tag creation step, and removes VERSION variable declarations in shell scripts
.github/workflows/documentation.yaml	Adds path filters, changes deployment from GitHub Pages-only to include nightly releases, removes branch restrictions on pull_request trigger
.github/workflows/changelog-check.yaml	Changes CHANGELOG.md path from root to hardware/ subdirectory, adds path filters to reduce unnecessary workflow runs
.github/workflows/astyle.yaml	Adds master_branch environment variable (set to "master")
.github/copilot-instructions.md	Completely removes 502-line file containing project-specific Copilot guidance

Comments suppressed due to low confidence (1)

.github/workflows/release.yaml:121

The script references $VERSION on line 121, but this shell variable is not defined in this step. Since VERSION is a GitHub Actions environment variable from a previous step, it needs to be accessed as ${{ env.VERSION }} or defined at the start of the script as VERSION="${{ env.VERSION }}".

      - name: Generate release notes with diff
        run: |
          # Get the previous release tag (without v prefix)
          PREVIOUS_TAG=$(git tag --sort=-v:refname | grep -E '^[0-9]+\.[0-9]+\.[0-9]+' | head -n 1 || true)
          
          echo "RELEASE_NOTES<<EOF" >> $GITHUB_ENV
          
          if [ -n "$PREVIOUS_TAG" ]; then
            echo "## Changes" >> $GITHUB_ENV
            echo "" >> $GITHUB_ENV
            git log $PREVIOUS_TAG..HEAD --pretty=format:"- %s (%h)" >> $GITHUB_ENV || true
            echo "" >> $GITHUB_ENV
            echo "" >> $GITHUB_ENV
            echo "See [CHANGELOG.md](CHANGELOG.md) for full details." >> $GITHUB_ENV
          else
            echo "## Release $VERSION" >> $GITHUB_ENV

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-01-27T13:24:10Z

+    paths:
+      - 'hardware/CHANGELOG.md'


The workflow is configured to validate the changelog at path 'hardware/CHANGELOG.md', but the repository structure shows CHANGELOG.md is located in the root directory, not in a 'hardware/' subdirectory. This will cause the workflow to fail when trying to find the file. The path should be 'CHANGELOG.md' instead of 'hardware/CHANGELOG.md'.

Copilot · 2026-01-27T13:24:10Z

          sed -i -E "s/set\([A-Z_]*VERSION[A-Z_]* [^)]*\)/set(\0 $VERSION)/g" CMakeLists.txt || true
          sed -i -E "s/set\([A-Z_]*LIB_VERSION[A-Z_]* [^)]*\)/set(\0 $VERSION)/g" CMakeLists.txt || true


The sed command syntax is incorrect. The pattern s/set$[A-Z_]*VERSION[A-Z_]* [^)]*$/set(\0 $VERSION)/g will replace the entire matched text with itself (\0) followed by the version, which will result in something like set(VERSION "1.0.0" 1.0.0) instead of replacing the version value. The command should be structured to capture and replace only the version value within the set() call, for example: s/(set$[A-Z_]*VERSION[A-Z_]* $[^)]*\)/\1\"$VERSION\")/g

Suggested change

sed -i -E "s/set$[A-Z_]*VERSION[A-Z_]* [^)]*$/set(\0 $VERSION)/g" CMakeLists.txt || true

sed -i -E "s/set$[A-Z_]*LIB_VERSION[A-Z_]* [^)]*$/set(\0 $VERSION)/g" CMakeLists.txt || true

sed -i -E "s/(set\([A-Z_]*VERSION[A-Z_]* )[^)]*/\1\"$VERSION\")/g" CMakeLists.txt || true

sed -i -E "s/(set\([A-Z_]*LIB_VERSION[A-Z_]* )[^)]*/\1\"$VERSION\")/g" CMakeLists.txt || true

Copilot · 2026-01-27T13:24:10Z

          REPO_URL="https://github.com/${{ github.repository }}"
-          VERSION="${{ env.VERSION }}"
-
+


The script references $VERSION on line 62, but this shell variable is not defined in this step. The VERSION was set as a GitHub Actions environment variable in the previous step using echo "VERSION=$VERSION" >> $GITHUB_ENV, which means it needs to be accessed as ${{ env.VERSION }} in the shell script, or the script needs to define a local shell variable at the start like VERSION="${{ env.VERSION }}" to make $VERSION work properly.

Suggested change

# Load version from GitHub Actions environment into a shell variable

VERSION="${{ env.VERSION }}"

Copilot · 2026-01-27T13:24:11Z

      - name: Update CMakeLists.txt
        run: |
-          VERSION="${{ env.VERSION }}"
          # Update version in CMakeLists.txt (searches for any VERSION variable)
          sed -i -E "s/set\([A-Z_]*VERSION[A-Z_]* [^)]*\)/set(\0 $VERSION)/g" CMakeLists.txt || true
          sed -i -E "s/set\([A-Z_]*LIB_VERSION[A-Z_]* [^)]*\)/set(\0 $VERSION)/g" CMakeLists.txt || true


The script references $VERSION on lines 92-93, but this shell variable is not defined in this step. Since VERSION is a GitHub Actions environment variable from a previous step, it needs to be accessed as ${{ env.VERSION }} or defined at the start of the script as VERSION="${{ env.VERSION }}".

Copilot · 2026-01-27T13:24:11Z

      - name: Update idf_component.yml
        run: |
-          VERSION="${{ env.VERSION }}"
          # Update version in idf_component.yml
          sed -i "s/^version: .*/version: \"$VERSION\"/" idf_component.yml


The script references $VERSION on line 98, but this shell variable is not defined in this step. Since VERSION is a GitHub Actions environment variable from a previous step, it needs to be accessed as ${{ env.VERSION }} or defined at the start of the script as VERSION="${{ env.VERSION }}".

Copilot · 2026-01-27T13:24:11Z

+    paths:
+      - 'hardware/CHANGELOG.md'


The workflow is configured to watch for changes to 'hardware/CHANGELOG.md', but the CHANGELOG.md file is located in the root directory of the repository, not in a 'hardware/' subdirectory. This path filter will never match changes to the actual CHANGELOG.md file. The path should be 'CHANGELOG.md' instead.

Copilot · 2026-01-27T13:24:11Z

      - name: Validate Changelog Format
        shell: bash
        run: |
-          CHANGELOG_FILE="CHANGELOG.md"
-
+          CHANGELOG_FILE="hardware/CHANGELOG.md"
+          
          if [ ! -f "$CHANGELOG_FILE" ]; then
-            echo "Error: CHANGELOG.md not found in directory"
+            echo "Error: CHANGELOG.md not found in hardware directory"
            exit 1
          fi


The script attempts to validate 'hardware/CHANGELOG.md', but this path does not exist in the repository. The CHANGELOG.md file is located in the root directory. This will cause the validation to fail with "Error: CHANGELOG.md not found in hardware directory". The CHANGELOG_FILE variable should be set to "CHANGELOG.md" instead.

Copilot · 2026-01-27T13:24:12Z

      - name: Check for duplicate issue numbers
        shell: bash
        run: |
-          CHANGELOG_FILE="CHANGELOG.md"
-
+          CHANGELOG_FILE="hardware/CHANGELOG.md"
+          


The script attempts to read from 'hardware/CHANGELOG.md', but this path does not exist in the repository. The CHANGELOG.md file is located in the root directory. The CHANGELOG_FILE variable should be set to "CHANGELOG.md" instead of "hardware/CHANGELOG.md".

Copilot · 2026-01-27T13:24:12Z

+env:
+  # Master branch (main or master)
+  master_branch: master
+


The master_branch environment variable is set to "master" in this workflow, but it's set to "main" in documentation.yaml and changelog-check.yaml. For consistency, all workflows should use the same value. Additionally, this environment variable doesn't appear to be used anywhere in any of the workflows, so it may be unnecessary.

Suggested change

env:

# Master branch (main or master)

master_branch: master

Revert "Improving CI/CD"

5611e65

This reverts commit 25ed4b9.

Copilot AI review requested due to automatic review settings January 27, 2026 13:18

Kampi merged commit 89df71f into main Jan 27, 2026
1 of 3 checks passed

Kampi deleted the revert-30-kampi/Issue-29 branch January 27, 2026 13:18

Copilot started reviewing on behalf of Kampi January 27, 2026 13:18 View session

Copilot AI reviewed Jan 27, 2026

View reviewed changes

		sed -i -E "s/set\([A-Z_]VERSION[A-Z_] [^)]*\)/set(\0 $VERSION)/g" CMakeLists.txt \|\| true
		sed -i -E "s/set\([A-Z_]LIB_VERSION[A-Z_] [^)]*\)/set(\0 $VERSION)/g" CMakeLists.txt \|\| true

		REPO_URL="https://github.com/${{ github.repository }}"
		VERSION="${{ env.VERSION }}"



	# Load version from GitHub Actions environment into a shell variable
	VERSION="${{ env.VERSION }}"

Uh oh!

Conversation

Kampi commented Jan 27, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Release Notes

Uh oh!

Uh oh!

coderabbitai Bot commented Jan 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review failed

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Jan 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 27, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Kampi commented Jan 27, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Jan 27, 2026 •

edited

Loading