Skip to content

TECH_DEBT: Update azure-pipelines.db-schema-creation.yaml - #1241

Merged
seanmcilvenna merged 2 commits into
devfrom
ed/techdebt-add-submission-to-db-process
Nov 6, 2025
Merged

TECH_DEBT: Update azure-pipelines.db-schema-creation.yaml#1241
seanmcilvenna merged 2 commits into
devfrom
ed/techdebt-add-submission-to-db-process

Conversation

@edward-miller-lcg

@edward-miller-lcg edward-miller-lcg commented Nov 6, 2025

Copy link
Copy Markdown
Contributor

🛠️ Description of Changes

Update "Generate Database Scripts" pipeline to include a job for the Submission service to generate the submission service database's SQL migration script

🧪 Testing Performed

Ran the pipeline against the branch and it successfully created the submission service's idempotent database SQL script.

🧑‍🔬 Unit Testing

N/A

📓 Documentation Updated

N/A

Summary by CodeRabbit

  • New Features
    • Integrated automated Submission database schema generation into the deployment pipeline with SQL script generation and artifact publication.

@coderabbitai

coderabbitai Bot commented Nov 6, 2025

Copy link
Copy Markdown
Contributor

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The PR adds a Submission job to the Azure Pipelines DB schema creation pipeline. This job installs dotnet-ef, runs migrations for SubmissionContext using configuration from Submission.csproj and Submission.Data.csproj, generates a SQL script (submissionDb.sql), and publishes it as a scripts artifact. The job definition appears duplicated in the pipeline configuration.

Changes

Cohort / File(s) Summary
Submission job addition
Azure_Pipelines/azure-pipelines.db-schema-creation.yaml
Added Submission job that installs dotnet-ef, executes migrations script for SubmissionContext, outputs SQL to staging directory, and publishes as artifact. Job appears twice in the file (duplicate).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

  • Duplicate job definition: Verify whether the Submission job appearing twice in the pipeline is intentional or a merge/edit error that needs correction.
  • Artifact naming consistency: Confirm that publishing the same artifact name twice does not cause conflicts or override issues.

Possibly related PRs

  • PR #768: Modifies the same Submission job in azure-pipelines.db-schema-creation.yaml, directly related to this change.
  • PR #769: Commented/removed the Submission job and its change-detection dependency in the same pipeline file.
  • PR #478: Adds a Submission job to generate and publish the submission DB migration script.

Suggested reviewers

  • amphillipsLGC
  • smailliwcs
  • michael-misiaszek

Poem

🐰 A Submission job we now deploy,
To schema scripts that bring us joy!
Though doubled scripts might cause a frown,
Let's review this before it's down. ✨

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'TECH_DEBT: Update azure-pipelines.db-schema-creation.yaml' is vague and generic, using non-descriptive phrasing that doesn't convey what specific change was made to the file. Provide a more descriptive title that specifies the actual change, such as 'Add Submission schema generation job to Azure Pipelines' or 'Fix duplicate Submission job in db-schema-creation pipeline'.
✅ Passed checks (2 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description check ✅ Passed The PR description addresses all required sections with concrete details about changes and testing performed.

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.

@coderabbitai coderabbitai Bot 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.

Actionable comments posted: 1

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

  • Jira integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 153ecc1 and 47cca56.

📒 Files selected for processing (1)
  • Azure_Pipelines/azure-pipelines.db-schema-creation.yaml (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**

⚙️ CodeRabbit configuration file

**: Pull requests that have "TECH_DEBT" in the title should only contain changes related to typos, unused code, linter/IDE suggestions, swagger specification updates,
and logging improvements. These TECH_DEBT PRs must not affect core functionality. All PRs that are not considered technical debt must include information on what
testing was performed in the description of the PR. If it does not, ask the author to provide details on what testing was performed.
When reviewing code, suggest unit tests using XUnit in the following scenarios:

  • If/Else or Switch/Case blocks are introduced or modified — ensure each branch has a corresponding unit test.
  • Logic that depends on service or interface configuration — suggest tests to validate different implementations are correctly resolved.
  • No network activity (HTTP calls, sockets, etc.) should appear in unit tests. Recommend using mocks (via Moq) for any external communication.
    Large unit tests should be avoided; keeping unit tests small and focused on targeted business logic (i.e. string sanitization)

**: Pull requests that have DOCS in the title should only contain changes related to documentation within the /docs folder or in .md files through-out the code-base. The description
of the PR should specify what documentation was updated. Documentation updates should use EventCatalog.dev structure, where service-specific functionality should be described
in the service's index.mdx (i.e. /services/XXX/index.mdx or /domains/XXX/services/YYY/index.mdx). Configurations that are shared by multiple services should be
reflected in the /docs/docs/config files.

Files:

  • Azure_Pipelines/azure-pipelines.db-schema-creation.yaml
🧠 Learnings (1)
📓 Common learnings
Learnt from: CR
Repo: lantanagroup/link-cloud PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-09-02T16:50:12.997Z
Learning: All non-TECH_DEBT PRs must include information on testing performed in the PR description
Learnt from: seanmcilvenna
Repo: lantanagroup/link-cloud PR: 560
File: docs/service_specs/tenant.md:49-69
Timestamp: 2024-12-04T16:30:56.051Z
Learning: In this project, PRs titled "TECH-DEBT" may include documentation changes, such as restructuring documentation, adding new API operations documentation, and enhancing endpoint descriptions.
Learnt from: CR
Repo: lantanagroup/link-cloud PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-09-02T16:50:12.997Z
Learning: The PR description must follow the provided template with sections: Description of Changes, Testing Performed, Unit Testing checkbox, and Documentation Updated
Learnt from: CR
Repo: lantanagroup/link-cloud PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-09-02T16:50:12.997Z
Learning: TECH_DEBT pull requests must only include typos, unused code removal, linter/IDE suggestions, Swagger specification updates, documentation (e.g., markdown files), and logging improvements
Learnt from: CR
Repo: lantanagroup/link-cloud PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-09-02T16:50:12.997Z
Learning: TECH_DEBT pull requests must not affect core functionality
Learnt from: CR
Repo: lantanagroup/link-cloud PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-09-02T16:50:12.997Z
Learning: All non-TECH_DEBT PRs must reference a JIRA ticket number for the LNK project in the PR summary
Learnt from: seanmcilvenna
Repo: lantanagroup/link-cloud PR: 593
File: docs/service_specs/submission.md:21-21
Timestamp: 2024-12-27T19:53:24.250Z
Learning: The DotNet/Submission project is deprecated and replaced by Java/Submission, and will be removed in a future PR.
Learnt from: edward-miller-lcg
Repo: lantanagroup/link-cloud PR: 1095
File: Tests/BackendE2ETests/ApiRequests/SubmissionZipReader.cs:235-297
Timestamp: 2025-09-10T03:18:32.895Z
Learning: User edward-miller-lcg prefers minimal logging in test scenarios and considers frequent progress updates during polling loops to be "too noisy" for test output.
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: Analyze (csharp)
  • GitHub Check: Analyze (java-kotlin)
🔇 Additional comments (3)
Azure_Pipelines/azure-pipelines.db-schema-creation.yaml (3)

251-270: Complete the PR description before merging.

The PR description currently contains only template placeholders with no actual content. Per project guidelines, the description must include:

  1. Description of Changes — Explain why the Submission job is being added to the schema generation pipeline
  2. Testing Performed — Detail what testing was done to verify this change
  3. Documentation Updated section status

Additionally, clarify the apparent conflict with the codebase note that DotNet/Submission is deprecated.


262-262: Paths are correct and intentional.

Both csproj files exist and the split is appropriate for Entity Framework migrations:

  • DotNet/Submission/Submission.csproj (startup project for -s)
  • DotNet/Submission.Data/Submission.Data.csproj (migrations project for -p)

The SubmissionContext class is correctly located in the Submission.Data project.

Note: Given that the DotNet/Submission project is deprecated (per previous context), this pipeline step's future relevance should be tracked alongside the deprecation removal timeline.


251-270: Disregard duplication concern—exactly one Submission job exists.

Verification confirms the Submission job appears only once in the pipeline (at line 252). No duplication is present in the final state.

Likely an incorrect or invalid review comment.

Comment thread Azure_Pipelines/azure-pipelines.db-schema-creation.yaml
@seanmcilvenna
seanmcilvenna merged commit 7cdc108 into dev Nov 6, 2025
15 checks passed
@seanmcilvenna
seanmcilvenna deleted the ed/techdebt-add-submission-to-db-process branch November 6, 2025 19:09
@coderabbitai coderabbitai Bot mentioned this pull request Nov 12, 2025
1 task
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