Skip to content

Update documentation #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 14 commits into from
Jun 15, 2025
Merged

Update documentation #30

merged 14 commits into from
Jun 15, 2025

Conversation

JimboSchneider
Copy link
Owner

@JimboSchneider JimboSchneider commented Jun 7, 2025

  • Updated the ignore and readme.md
  • Added in About page with version information

- Fixed timing issues in E2E tests by consolidating wait logic
- Improved selector specificity to avoid ambiguous element matches
- Updated README with CI/CD workflow documentation
- Enhanced E2E test instructions for local development

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

Co-Authored-By: Claude <[email protected]>
@Copilot Copilot AI review requested due to automatic review settings June 7, 2025 23:27
Copilot

This comment was marked as outdated.

JimboSchneider and others added 2 commits June 7, 2025 17:43
- Set initial version to 0.0.1 reflecting early development state
- Display version in footer on all pages
- Add comprehensive About page with version and system information
- Update navigation to include About page link

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

Co-Authored-By: Claude <[email protected]>
@JimboSchneider JimboSchneider enabled auto-merge (squash) June 8, 2025 00:36
@JimboSchneider JimboSchneider disabled auto-merge June 8, 2025 00:36
JimboSchneider and others added 3 commits June 7, 2025 20:03
- Increase CI wait time to 60s for better service startup reliability
- Update login test assertion to match actual error message format
- Use C# 12 collection expressions throughout codebase
- Add default values to Post model properties for null safety

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

Co-Authored-By: Claude <[email protected]>
@JimboSchneider JimboSchneider requested a review from Copilot June 8, 2025 02:48
Copilot

This comment was marked as outdated.

@JimboSchneider JimboSchneider self-assigned this Jun 8, 2025
JimboSchneider and others added 2 commits June 7, 2025 21:23
…orkflow

- Switch from bash to PowerShell for cross-platform compatibility
- Update cache action from v3 to v4
- Add proper background process handling for Windows and Linux
- Implement health checks with 120-second timeout for services
- Add process cleanup that runs even on failure
- Capture and upload service logs as artifacts on failure
- Use platform-appropriate path handling

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

Co-Authored-By: Claude <[email protected]>
- Increase timeout from 120 to 300 seconds for slower CI environments
- Use more descriptive variable names ($siloPid, $blazorPid) for clarity

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

Co-Authored-By: Claude <[email protected]>
@JimboSchneider JimboSchneider requested a review from Copilot June 8, 2025 03:53
Copilot

This comment was marked as outdated.

Copy link
Owner Author

@JimboSchneider JimboSchneider left a comment

Choose a reason for hiding this comment

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

I need to fix up the CI as the tests are failing currently as this is just an in memory db. I need to create a persistent db and then I can start activating the e2e tests.

Comment out E2E test execution step until tests are ready for reliable execution.
This prevents PR builds from failing due to incomplete E2E test implementation.
- Replace nohup with PowerShell Start-Process for better process management
- Add immediate process verification after starting services
- Replace Windows-specific Test-NetConnection with cross-platform TCP client
- Add continuous process monitoring during health checks
- Separate stdout and stderr into different log files for better debugging
- Enhanced failure diagnostics with comprehensive log output
- Properly handle HTTPS certificate validation differences between platforms
- Consistent PID tracking across Windows and Linux

These changes should significantly reduce flakiness by catching startup
failures immediately and providing better visibility into service failures.
@JimboSchneider JimboSchneider requested a review from Copilot June 15, 2025 16:02
Copy link
Contributor

@Copilot Copilot AI left a comment

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 enriches project documentation, introduces version metadata, and surfaces version information in the UI, while updating model null-safety, tests, and the CI/CD workflow.

  • Enhanced README with CI/CD details and clarified end-to-end test setup.
  • Added About page and footer to display application and assembly versions.
  • Enforced non-null defaults in models, migrated tests to C#12 syntax, and expanded GitHub Actions for cross-platform service startup and health checks.

Reviewed Changes

Copilot reviewed 15 out of 15 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
README.md Updated end-to-end instructions and added CI/CD section
OrleansBlog/OrleansBlog.csproj Added Version, AssemblyVersion, and FileVersion metadata
OrleansBlog/Models/Post.cs Introduced default initializers and required modifiers
OrleansBlog/Components/Pages/Post.razor Replaced Array.Empty<string>() with C#12 [] collection expr.
OrleansBlog/Components/Pages/About.razor New About page displaying version and environment info
OrleansBlog/Components/Layout/NavMenu.razor Added About navigation link
OrleansBlog/Components/Layout/MainLayout.razor Swapped external About link for local, added version footer
OrleansBlog/Components/Layout/MainLayout.razor.css Added footer styling
OrleansBlog.Tests/PostServiceTests.cs Updated tests to use collection expressions and null-forgiving operator
OrleansBlog.E2E.Tests/TestHelpers/UserTestHelpers.cs Increased Playwright visibility timeout
OrleansBlog.E2E.Tests/LoginTests.cs Modified expected error message and timeout
OrleansBlog.Abstractions/Models/Post.cs Added default initializers to record properties
.github/workflows/pr-build.yml Upgraded cache action, added cross-platform startup, health checks, and cleanup steps
Comments suppressed due to low confidence (1)

OrleansBlog.E2E.Tests/LoginTests.cs:41

  • The test now expects an "Error: Invalid login attempt." message, but the UI hasn't been updated to include the Error: prefix. Either update the UI error text or revert the test to match the existing message.
await Expect(Page.GetByText("Error: Invalid login attempt.")).ToBeVisibleAsync(new() { Timeout = 10000 });

@JimboSchneider JimboSchneider merged commit 9187ff0 into main Jun 15, 2025
2 checks passed
@JimboSchneider JimboSchneider deleted the fix/e2e-test-reliability branch June 15, 2025 16:11
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.

1 participant