Skip to content

Conversation

@marcorensch
Copy link
Contributor

@marcorensch marcorensch commented Jan 6, 2026

User description

Added warning about update scripts not executing during initial installation.


PR Type

Documentation


Description

  • Added warning clarifying update scripts don't execute during initial installation

  • Emphasized that install.sql must contain current database schema status


Diagram Walkthrough

flowchart LR
  A["Installation Documentation"] -- "adds clarification" --> B["Update Scripts Warning"]
  B -- "explains" --> C["Install SQL Requirements"]
Loading

File Walkthrough

Relevant files
Documentation
manifest.md
Add installation update script execution warning                 

versioned_docs/version-6.0/building-extensions/install-update/installation/manifest.md

  • Added warning box clarifying that update scripts don't execute during
    initial component installation
  • Documented requirement that example.install.sql must contain current
    database schema status
  • Placed warning before existing TODO note for better visibility
+5/-0     

Added warning about update scripts not executing during initial installation.
@qodo-code-review
Copy link
Contributor

PR Compliance Guide 🔍

Below is a summary of compliance checks for this PR:

Security Compliance
🟢
No security concerns identified No security vulnerabilities detected by AI analysis. Human verification advised for critical code.
Ticket Compliance
🎫 No ticket provided
  • Create ticket/issue
Codebase Duplication Compliance
Codebase context is not defined

Follow the guide to enable codebase context checks.

Custom Compliance
🟢
Generic: Comprehensive Audit Trails

Objective: To create a detailed and reliable record of critical system actions for security analysis
and compliance.

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Meaningful Naming and Self-Documenting Code

Objective: Ensure all identifiers clearly express their purpose and intent, making code
self-documenting

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Robust Error Handling and Edge Case Management

Objective: Ensure comprehensive error handling that provides meaningful context and graceful
degradation

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Secure Error Handling

Objective: To prevent the leakage of sensitive system information through error messages while
providing sufficient detail for internal debugging.

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Secure Logging Practices

Objective: To ensure logs are useful for debugging and auditing without exposing sensitive
information like PII, PHI, or cardholder data.

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Security-First Input Validation and Data Handling

Objective: Ensure all data inputs are validated, sanitized, and handled securely to prevent
vulnerabilities

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Compliance status legend 🟢 - Fully Compliant
🟡 - Partial Compliant
🔴 - Not Compliant
⚪ - Requires Further Human Verification
🏷️ - Compliance label

@qodo-code-review
Copy link
Contributor

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Impact
General
Improve clarity and avoid ambiguity

Improve the clarity of the documentation by rephrasing a sentence about the
installation SQL file to be less redundant and by using a more generic filename
example.

versioned_docs/version-6.0/building-extensions/install-update/installation/manifest.md [348]

-The `example.install.sql` must contain the current status of all database changes and thus describe the current status.
+The installation SQL file (e.g., `install.sql`) must contain the complete database schema.
  • Apply / Chat
Suggestion importance[1-10]: 4

__

Why: The suggestion correctly identifies redundant phrasing and a potentially misleading filename in the documentation, offering a clearer and more concise alternative.

Low
  • More

@HLeithner
Copy link
Member

I think that's a not needed warning here, because if you install a component it can't update anything so why should someone think that the update script is get executed?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants