-
Notifications
You must be signed in to change notification settings - Fork 32
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
Remove temporary build step #3245
Conversation
WalkthroughThe pull request modifies the GitHub Actions workflow for UI deployment by removing the "Build synapse-constants" step from the Changes
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
Deploying sanguine-fe with Cloudflare Pages
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (3)
docs/bridge/README.md (1)
25-30
: Enhance the new section with more context and address formatting issues.The new section "Ensure search is indexed to latest version" is a valuable addition, but it could benefit from more context and explanation. Consider the following improvements:
- Add a brief explanation of why this step is necessary and what
yarn serve
does.- Specify the language for the code block to improve syntax highlighting.
- Remove the dollar sign from the command to align with Markdown best practices.
Here's a suggested revision:
### Ensure search is indexed to latest version To make sure the search functionality includes the latest content, run the following command: ```bash yarn serveThis command serves the built website locally, allowing search indexing to update with the latest changes.
This revision addresses the Markdownlint issues and provides more context for users. <details> <summary>🧰 Tools</summary> <details> <summary>🪛 Markdownlint</summary><blockquote> 28-28: null Dollar signs used before commands without showing output (MD014, commands-show-output) --- 27-27: null Fenced code blocks should have a language specified (MD040, fenced-code-language) </blockquote></details> </details> </blockquote></details> <details> <summary>packages/explorer-ui/README.md (2)</summary><blockquote> `5-6`: **LGTM! Consider prioritizing these tasks.** The TODO items are clear and important for the project. Consider prioritizing these tasks: 1. Adding a readme for the Explorer UI will improve documentation and help onboard new developers. 2. Adding integration tests will enhance the reliability and maintainability of the UI. It might be helpful to assign these tasks to specific team members or create GitHub issues to track their progress. --- `20-20`: **LGTM! Consistent use of Yarn and removal of 'eject' command.** The changes from `npm test` to `yarn test` and `npm run build` to `yarn build` are appropriate and consistent with the switch to Yarn. The descriptions accurately explain the commands' functionalities. Note that the 'eject' command section has been removed. This is generally fine as ejecting is an irreversible action and is rarely needed. However, if there's a specific reason why users of this project might need to eject, consider adding a brief note about it. Also applies to: 24-24 </blockquote></details> </blockquote></details> <details> <summary>📜 Review details</summary> **Configuration used: .coderabbit.yaml** **Review profile: CHILL** <details> <summary>📥 Commits</summary> Files that changed from the base of the PR and between a3dbb19f600ded1bc6d413dd1fda1844c302e623 and e07713a0d980059d431f1cad7cbfe67a244ad12d. </details> <details> <summary>📒 Files selected for processing (2)</summary> * docs/bridge/README.md (2 hunks) * packages/explorer-ui/README.md (1 hunks) </details> <details> <summary>🧰 Additional context used</summary> <details> <summary>🪛 Markdownlint</summary><blockquote> <details> <summary>docs/bridge/README.md</summary><blockquote> 28-28: null Dollar signs used before commands without showing output (MD014, commands-show-output) --- 27-27: null Fenced code blocks should have a language specified (MD040, fenced-code-language) </blockquote></details> </blockquote></details> </details> <details> <summary>🔇 Additional comments (1)</summary><blockquote> <details> <summary>packages/explorer-ui/README.md (1)</summary><blockquote> `12-12`: **LGTM! Consistent use of Yarn.** The change from `npm start` to `yarn start` is appropriate and consistent with modern JavaScript project management practices. The description accurately explains the command's functionality. </blockquote></details> </blockquote></details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #3245 +/- ##
============================================
Coverage ? 90.43902%
============================================
Files ? 54
Lines ? 1025
Branches ? 82
============================================
Hits ? 927
Misses ? 95
Partials ? 3
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Bundle ReportChanges will decrease total bundle size by 4.15MB (-11.65%) ⬇️. This is within the configured threshold ✅ Detailed changes
ℹ️ *Bundle size includes cached data from a previous commit |
Summary by CodeRabbit
Chores
synapse-constants
.Documentation
npm
commands withyarn
commands and removed thenpm run eject
section.