Skip to content

Optimize workflow triggers and update solution file#19

Merged
ncipollina merged 4 commits into
mainfrom
feature/optimize-workflow-triggers
Jul 10, 2025
Merged

Optimize workflow triggers and update solution file#19
ncipollina merged 4 commits into
mainfrom
feature/optimize-workflow-triggers

Conversation

@ncipollina

Copy link
Copy Markdown
Contributor

Summary

  • Optimize GitHub Actions workflow triggers for better separation between documentation and code builds
  • Add path filtering to MkDocs workflow to only run on documentation changes
  • Expand path exclusions in build workflow to prevent unnecessary builds
  • Update solution file configuration

Changes

MkDocs Workflow (mkdocs-material-gh-pages.yml)

  • Added paths filter to only trigger on:
    • docs/** - Documentation content changes
    • mkdocs.yml - MkDocs configuration changes
    • requirements.txt - Python dependencies for MkDocs
  • Maintains workflow_dispatch for manual triggering

Build Workflow (build.yaml)

  • Expanded paths-ignore to exclude:
    • docs/** - Documentation content (existing)
    • README.md - Project documentation (new)
    • mkdocs.yml - MkDocs configuration (new)
    • requirements.txt - MkDocs dependencies (new)

Solution File

  • Updated solution file configuration

Benefits

  • Reduced CI/CD costs: No unnecessary .NET builds for documentation-only changes
  • Faster feedback: Documentation deploys independently without waiting for build pipeline
  • Clean separation: Documentation and code have distinct deployment workflows
  • Resource efficiency: Each workflow only runs when relevant files change

Test Scenarios

  • Documentation-only changes trigger only MkDocs workflow
  • Code-only changes trigger only build workflow
  • README.md changes trigger only MkDocs workflow
  • Mixed changes trigger appropriate workflows based on file paths
  • Manual workflow dispatch still works for both workflows

🤖 Generated with Claude Code

ncipollina and others added 2 commits July 10, 2025 13:27
- Add workflow_dispatch trigger to MkDocs deployment workflow for manual deployment
- Update documentation CSS theme import to use site.theme variable
- Update documentation content with improved formatting and structure
- Update project file with corrected icon path reference

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
- Add paths filter to MkDocs workflow (docs/**, mkdocs.yml, requirements.txt)
- Expand paths-ignore in build workflow (README.md, mkdocs.yml, requirements.txt)
- Update solution file configuration
- Create clean separation between documentation and code deployment pipelines
- Reduce CI/CD costs by preventing unnecessary builds for documentation-only changes

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
@ncipollina
ncipollina requested a review from Copilot July 10, 2025 19:10

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR optimizes CI workflows by filtering triggers for documentation changes and updates the solution file to include MkDocs and documentation assets.

  • Adds paths filter to the MkDocs workflow and keeps workflow_dispatch for manual runs
  • Expands paths-ignore in the build workflow to skip docs/config-only changes
  • Updates the .sln to include MkDocs config, requirements, and new solution folders for assets and CSS

Reviewed Changes

Copilot reviewed 3 out of 5 changed files in this pull request and generated 1 comment.

File Description
LayeredCraft.Cdk.Constructs.sln Added MkDocs workflow, docs files, and new solution folders; updated config maps
.github/workflows/mkdocs-material-gh-pages.yml Added workflow_dispatch and paths filter for docs, config, and requirements
.github/workflows/build.yaml Added README.md, mkdocs.yml, and requirements.txt to paths-ignore
Comments suppressed due to low confidence (1)

LayeredCraft.Cdk.Constructs.sln:60

  • [nitpick] The solution folder name css is very generic; consider renaming it to something more descriptive like docs-css or mkdocs-css to clarify its purpose.
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "css", "css", "{D7118124-AA5A-45AB-9075-E0F56BAB4F62}"

Comment thread LayeredCraft.Cdk.Constructs.sln
ncipollina and others added 2 commits July 10, 2025 15:13
- Remove .DS_Store files that were accidentally committed
- Add comprehensive macOS file exclusions to .gitignore:
  - .DS_Store and variants
  - macOS metadata files (._*, .Spotlight-V100, .Trashes)
  - Windows thumbnail files for cross-platform compatibility
- Prevents future accidental commits of system files

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
@ncipollina
ncipollina force-pushed the feature/optimize-workflow-triggers branch from c7e9bca to 46667db Compare July 10, 2025 19:52
@ncipollina
ncipollina merged commit 8509698 into main Jul 10, 2025
1 check passed
@ncipollina
ncipollina deleted the feature/optimize-workflow-triggers branch July 10, 2025 19:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants