Skip to content
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

Closed
wants to merge 2 commits into from

Conversation

abtestingalpha
Copy link
Collaborator

@abtestingalpha abtestingalpha commented Oct 7, 2024

Summary by CodeRabbit

  • Chores

    • Streamlined the UI deployment process by removing the build step for synapse-constants.
    • Added conditional checks for deployment based on the current branch.
  • Documentation

    • Updated instructions in the bridge README to ensure search functionality is indexed to the latest version.
    • Revised Explorer UI README to replace npm commands with yarn commands and removed the npm run eject section.

Copy link
Contributor

coderabbitai bot commented Oct 7, 2024

Walkthrough

The pull request modifies the GitHub Actions workflow for UI deployment by removing the "Build synapse-constants" step from the deploy job. This step previously involved navigating to the packages/synapse-constants directory, installing dependencies, and building the package. The workflow now includes a conditional check for deployment based on the current branch and retains the logic for setting the VERCEL_PROJECT_ID. Overall, the changes streamline the deployment process by omitting the build step for synapse-constants.

Changes

File Path Change Summary
.github/workflows/ui-preview.yaml Removed the "Build synapse-constants" step from the deploy job; added conditional deployment check based on the branch.
docs/bridge/README.md Added instructions for ensuring search functionality is indexed to the latest version, including the command $ yarn serve.
packages/explorer-ui/README.md Replaced npm commands with yarn commands in the "Available Scripts" section; removed npm run eject command and duplicated TODO section.

Possibly related PRs

  • configure bundle analyzer #2836: The changes in this PR involve modifications to the .github/workflows/ui-preview.yaml file, which is also affected in the main PR. Both PRs deal with the GitHub Actions workflow configuration, specifically related to deployment processes.
  • fix constants publish [SLT-160] #3224: This PR includes changes to the packages/synapse-constants/package.json and the webpack.config.js file for synapse-constants, which is directly related to the main PR's removal of the build step for synapse-constants in the deployment workflow.

Suggested labels

M-docs, M-explorer-ui, M-synapse-interface, size/s

Suggested reviewers

  • bigboydiamonds
  • trajan0x

Poem

In the garden where workflows grow,
A step was trimmed, now smoother the flow.
With branches checked, the path is clear,
Deployments sing, no need to fear!
Hops of joy for code so neat,
A streamlined dance, oh what a treat! 🐇✨


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?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot added M-ci Module: CI size/xs labels Oct 7, 2024
Copy link

cloudflare-workers-and-pages bot commented Oct 7, 2024

Deploying sanguine-fe with  Cloudflare Pages  Cloudflare Pages

Latest commit: e07713a
Status: ✅  Deploy successful!
Preview URL: https://72bf5bb5.sanguine-fe.pages.dev
Branch Preview URL: https://ui-deployment-remove-temp-bu.sanguine-fe.pages.dev

View logs

Copy link
Contributor

@coderabbitai coderabbitai bot left a 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:

  1. Add a brief explanation of why this step is necessary and what yarn serve does.
  2. Specify the language for the code block to improve syntax highlighting.
  3. 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 serve

This 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 -->

Copy link

codecov bot commented Oct 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (master@8311329). Learn more about missing BASE report.
Report is 15 commits behind head on master.

Additional details and impacted files
@@             Coverage Diff              @@
##             master       #3245   +/-   ##
============================================
  Coverage          ?   90.43902%           
============================================
  Files             ?          54           
  Lines             ?        1025           
  Branches          ?          82           
============================================
  Hits              ?         927           
  Misses            ?          95           
  Partials          ?           3           
Flag Coverage Δ
packages 90.43902% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@abtestingalpha abtestingalpha deleted the ui-deployment/remove-temp-build branch October 8, 2024 14:56
Copy link

codecov bot commented Oct 8, 2024

Bundle Report

Changes will decrease total bundle size by 4.15MB (-11.65%) ⬇️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sdk-router-@synapsecns/sdk-router-esm 255.08kB 426 bytes (0.17%) ⬆️
sdk-router-@synapsecns/sdk-router-cjs 117.47kB 234 bytes (0.2%) ⬆️
explorer-ui-server-cjs* 708.77kB 157.29kB (-18.16%) ⬇️
explorer-ui-client-array-push* 2.15MB 162.81kB (-7.04%) ⬇️
synapse-interface-client-array-push* 7.38MB 100.07kB (1.38%) ⬆️
synapse-interface-server-cjs* 1.65MB 150.9kB (10.1%) ⬆️
widget-cjs-esm* 271.27kB 2.03kB (-0.74%) ⬇️
docs-bridge-client-array-push* 7.18MB 724.77kB (-9.17%) ⬇️
docs-bridge-server-cjs* 11.17MB 3.71MB (-24.92%) ⬇️
synapse-constants-esm-cjs* 174.63kB 174.63kB (100%) ⬆️
synapse-constants-cjs-esm* 174.18kB 174.18kB (100%) ⬆️

ℹ️ *Bundle size includes cached data from a previous commit

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.

1 participant