Skip to content

fix(ci): add publishing terms to cspell dictionary#601

Merged
imran-siddique merged 2 commits intomicrosoft:mainfrom
imran-siddique:fix/cspell-publishing-terms
Mar 30, 2026
Merged

fix(ci): add publishing terms to cspell dictionary#601
imran-siddique merged 2 commits intomicrosoft:mainfrom
imran-siddique:fix/cspell-publishing-terms

Conversation

@imran-siddique
Copy link
Copy Markdown
Member

Adds 10 project-specific terms to .cspell-repo-terms.txt\ that are used in \PUBLISHING.md\ and were flagged by the spell-check workflow: ESRP, esrp, GOPROXY, Dockerfiles, SCAK, scak, caas, HEALTHCHECK, pmcrepo, npmjs.

@imran-siddique imran-siddique enabled auto-merge (squash) March 30, 2026 21:50
@github-actions github-actions bot added the size/S Small PR (< 50 lines) label Mar 30, 2026
Copy link
Copy Markdown

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

🤖 AI Agent: code-reviewer

Review Feedback

This pull request updates the .cspell-repo-terms.txt file to include project-specific terms flagged by the spell-check workflow. While this change is minor and does not directly affect the core functionality or security of the repository, it is worth reviewing for potential indirect implications.


🔴 CRITICAL

No critical security issues identified in this pull request.


🟡 WARNING

No breaking changes identified in this pull request.


💡 SUGGESTION

  1. Documentation Alignment
    Ensure that the added terms are consistently used across the repository and are documented in a glossary or README file. This will help contributors understand their context and usage.

    Example:

    • What does "SCAK" or "pmcrepo" refer to? If these are acronyms or project-specific terms, consider adding a brief explanation in the PUBLISHING.md file or a dedicated glossary.
  2. Case Sensitivity
    While adding both uppercase and lowercase versions of terms (e.g., ESRP and esrp) is helpful for spell-checking, ensure that this approach aligns with your repository's naming conventions. If certain terms are always intended to be uppercase (e.g., acronyms), you might not need the lowercase variants.

  3. Workflow Validation
    After updating the .cspell-repo-terms.txt file, verify that the spell-check workflow passes successfully. This ensures that the added terms are correctly recognized and no additional terms are flagged.

  4. Future Maintenance
    Consider adding a comment at the top of .cspell-repo-terms.txt explaining its purpose and how contributors can update it. This will make it easier for new contributors to understand its role in the repository.


Summary

This pull request is straightforward and does not introduce any security, compatibility, or functionality concerns. The changes are appropriate for improving the spell-check workflow. Implementing the suggestions above will enhance clarity and maintainability.

@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 30, 2026

🤖 AI Agent: security-scanner — Security Review

This pull request modifies the .cspell-repo-terms.txt file to add project-specific terms to the spell-check dictionary. While this change appears to be low-risk and primarily related to improving the CI/CD workflow, it is still important to evaluate whether any of the added terms could introduce security concerns, especially in a security-focused repository like this one.

Security Review

1. Prompt Injection Defense Bypass

No impact. The changes are limited to a spell-check dictionary and do not affect the prompt handling or input sanitization mechanisms.

2. Policy Engine Circumvention

No impact. The changes do not modify the policy engine or its enforcement mechanisms.

3. Trust Chain Weaknesses

No impact. The changes do not involve trust chain validation, SPIFFE/SVID handling, or certificate pinning.

4. Credential Exposure

No impact. The changes do not introduce or expose any credentials, secrets, or sensitive information.

5. Sandbox Escape

No impact. The changes do not involve container or process isolation mechanisms.

6. Deserialization Attacks

No impact. The changes do not involve deserialization of untrusted data.

7. Race Conditions

No impact. The changes do not involve concurrent operations or time-of-check-to-time-of-use (TOCTOU) vulnerabilities.

8. Supply Chain

🟡 MEDIUM: The addition of terms like GOPROXY, npmjs, pmcrepo, and Dockerfiles could indicate references to external package repositories or build systems. While this change itself does not directly introduce a supply chain vulnerability, it is worth ensuring that these terms are not inadvertently normalizing or legitimizing insecure practices in the repository (e.g., using unverified or untrusted sources for dependencies).

  • Attack Vector: If these terms are later used in scripts or documentation to reference external resources, there is a risk of dependency confusion or typosquatting attacks if proper validation and pinning are not enforced.
  • Suggested Fix: Ensure that any references to external package repositories or build systems in the repository (e.g., GOPROXY, npmjs, pmcrepo) are accompanied by strict validation mechanisms, such as checksum verification, dependency pinning, and the use of trusted sources.

Rating of Findings

  • Supply Chain: 🟡 MEDIUM

Recommendations

  1. Conduct a review of the repository to ensure that any references to GOPROXY, npmjs, pmcrepo, or Dockerfiles are secure and follow best practices for dependency management and supply chain security.
  2. Consider adding a note in the documentation or CI/CD pipeline to enforce dependency validation (e.g., checksum verification, signature validation) for external resources.

Overall Assessment

The changes in this pull request are low-risk and primarily related to improving the spell-check workflow. However, the addition of terms related to external package repositories and build systems warrants a quick review of the repository's supply chain security practices.

Add ESRP, GOPROXY, Dockerfiles, SCAK, caas, HEALTHCHECK, pmcrepo,
and npmjs to the repo-terms dictionary. These are used in
PUBLISHING.md and were flagged by the spell-check workflow.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@imran-siddique imran-siddique force-pushed the fix/cspell-publishing-terms branch from d6e3fe1 to 28bbd7e Compare March 30, 2026 23:34
@github-actions github-actions bot added the size/XS Extra small PR (< 10 lines) label Mar 30, 2026
Copy link
Copy Markdown

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

🤖 AI Agent: code-reviewer

Review Feedback for PR: fix(ci): add publishing terms to cspell dictionary

Summary

This pull request adds project-specific terms to the .cspell-repo-terms.txt file to prevent false positives in the spell-check workflow. The changes are straightforward and address the issue of flagged terms in the PUBLISHING.md file.


🔍 Focus Area Review

1. Policy Engine Correctness

  • No direct impact on the policy engine correctness as this change is related to spell-checking and CI/CD workflows.

2. Trust/Identity

  • No trust or identity-related changes are introduced in this PR.

3. Sandbox Escape Vectors

  • No sandbox escape vectors are introduced or modified.

4. Thread Safety

  • No threading or concurrency-related changes are present in this PR.

5. OWASP Agentic Top 10 Compliance

  • This change does not affect compliance with OWASP Agentic Top 10.

6. Type Safety and Pydantic Model Validation

  • No type safety or Pydantic model validation concerns are relevant here.

7. Backward Compatibility

  • 🟡 WARNING: Adding terms to the .cspell-repo-terms.txt file is backward-compatible for the repository itself. However, if external contributors rely on the spell-check configuration, they may need to update their local workflows to include the updated dictionary file.

Recommendations

🔴 CRITICAL

No critical issues identified.

🟡 WARNING

  1. Potential Breaking Change for External Contributors:
    • If external contributors use the spell-check workflow locally, they may encounter issues if their local .cspell-repo-terms.txt file is outdated. Consider documenting this change in the CONTRIBUTING.md file or notifying contributors via release notes.

💡 SUGGESTIONS

  1. Improve Documentation:

    • Add a brief comment in the .cspell-repo-terms.txt file explaining why these terms were added (e.g., "Terms used in publishing workflows and documentation").
    • Update the PUBLISHING.md file to reference the spell-check workflow, if applicable.
  2. Automated Validation:

    • Consider adding a CI/CD step to validate that .cspell-repo-terms.txt is synchronized with the terms used across key documentation files (e.g., PUBLISHING.md).

Final Assessment

This PR is low-risk and improves the developer experience by reducing false positives in the spell-check workflow. Address the warning and suggestions to ensure smooth adoption for external contributors.

Copy link
Copy Markdown

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

🤖 AI Agent: code-reviewer

Review of Pull Request: fix(ci): add publishing terms to cspell dictionary

Summary

This pull request adds project-specific terms to the .cspell-repo-terms.txt file to prevent false positives in the spell-check workflow. These terms are relevant to the project's publishing documentation (PUBLISHING.md) and include technical terms and acronyms.


Feedback

🔴 CRITICAL

No critical security issues found in this pull request. The changes are limited to updating the spell-check dictionary, which does not impact the security, correctness, or functionality of the codebase.


🟡 WARNING

No breaking changes detected. The updates to the spell-check dictionary do not affect the public API or backward compatibility.


💡 SUGGESTION

  1. Documentation Update:
    Consider adding a comment in the .cspell-repo-terms.txt file explaining why these terms were added. This will help future contributors understand the context of these entries. For example:

    # Terms added for publishing documentation (PUBLISHING.md)
    
  2. Workflow Validation:
    After merging this pull request, ensure that the spell-check workflow passes successfully for PUBLISHING.md. This will confirm that the added terms resolve the flagged issues.

  3. Consistency in Case:
    You added both uppercase and lowercase versions of some terms (e.g., ESRP and esrp). While this is generally a good practice, ensure that this approach is consistent across all terms. For example, you added SCAK but not scak. If both uppercase and lowercase versions are used in the documentation, consider adding scak as well.

  4. Term Validation:
    Double-check that all added terms are spelled correctly and are relevant to the project. For example:

    • HEALTHCHECK is a valid Docker instruction, but confirm its usage in the documentation.
    • pmcrepo and scak seem project-specific; ensure their spelling aligns with internal conventions.

Conclusion

This pull request is straightforward and addresses a minor CI issue. It is safe to merge after verifying the spell-check workflow passes and ensuring consistency in term handling.

@imran-siddique imran-siddique merged commit 170aa03 into microsoft:main Mar 30, 2026
24 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/S Small PR (< 50 lines) size/XS Extra small PR (< 10 lines)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant