Skip to content

Conversation

@konard
Copy link
Member

@konard konard commented Sep 13, 2025

🎯 Summary

This PR implements the solution for issue #2 by moving yml configuration files from the Scripts repository to the Settings repository and updating all references to use the new location.

📋 Changes Made

Files Moved to Settings Repository

  • filter.yml - API filtering rules for DocFX documentation generation
  • toc.yml - Table of contents configuration for documentation sites

Scripts Repository Updates

  • MultiProjectRepository/csharpCdWorkflow.yml:
    • Added SETTINGS_BASE_URL environment variable
    • Updated wget commands to download filter.yml and toc.yml from Settings repository
  • SingleProjectRepository/publish-docs.sh:
    • Added Settings repository URL configuration
    • Added wget command to download toc.yml before processing

Files Removed

  • MultiProjectRepository/filter.yml
  • MultiProjectRepository/toc.yml
  • SingleProjectRepository/toc.yml

🔧 Implementation Details

The solution maintains backward compatibility by:

  1. Keeping docfx.json files unchanged - they still reference yml files locally
  2. Having workflows download the yml files from Settings repository before running documentation scripts
  3. Using the existing $REPOSITORY_NAME variable substitution in yml files

📁 Settings Repository Files

The following files need to be added to the root of the Settings repository:

filter.yml:

apiRules:
- exclude:
    uidRegex: (Tests|Benchmarks)(\.[A-Za-z]+)?$
- exclude:
    uidRegex: CSharpToCppTranslator$

toc.yml:

- name: Home
  href: README.md
- name: API Documentation
  href: obj/api/
  homepage: api/Platform.$REPOSITORY_NAME.html

✅ Testing Required

After merging and adding files to Settings repository:

  • Test C# project documentation generation
  • Verify DocFX processing works correctly
  • Confirm GitHub Actions workflows complete successfully

🔗 Fixes

Fixes #2


🤖 Generated with Claude Code

Adding CLAUDE.md with task information for AI processing.
This file will be removed when the task is complete.

Issue: #2
@konard konard self-assigned this Sep 13, 2025
- Remove filter.yml, toc.yml from Scripts repository
- Update csharpCdWorkflow.yml to download yml files from Settings repository
- Update publish-docs.sh to download toc.yml from Settings repository
- Add SETTINGS_BASE_URL environment variable for Settings repository references

The yml configuration files (filter.yml, toc.yml) are now centralized in the Settings repository and downloaded by workflows as needed.

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

Co-Authored-By: Claude <[email protected]>
@konard konard changed the title [WIP] Move yml files to Settings repository Move yml configuration files to Settings repository Sep 13, 2025
@konard konard marked this pull request as ready for review September 13, 2025 15:59
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.

Move yml files to Settings repository

2 participants