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 deprecated react explorer (client directory) #585

Merged
merged 9 commits into from May 21, 2024

Conversation

marc-aurele-besner
Copy link
Collaborator

@marc-aurele-besner marc-aurele-besner commented May 10, 2024

User description

Remove deprecated react explorer (client directory)

As we have ported this project to NextJS and moved it to the explorer directory, this PR deletes the old client directory and fixes workflows that were using this directory.


PR Type

enhancement


Description

  • Removed the entire client directory as the project has transitioned to NextJS and moved to the explorer directory.
  • Updated GitHub Actions build workflow to adjust the working directory from client to explorer.
  • Removed deployment workflow as deployment is now handled via Netlify hooks.
  • Added a root .gitignore to ignore .DS_Store files.

Changes walkthrough 📝

Relevant files
Configuration changes
build.yaml
Update build workflow to use new explorer directory           

.github/workflows/build.yaml

  • Updated the workflow to change the working directory from client to
    explorer.
  • +2/-2     

    💡 PR-Agent usage:
    Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

    @marc-aurele-besner marc-aurele-besner linked an issue May 10, 2024 that may be closed by this pull request
    Copy link

    netlify bot commented May 10, 2024

    Deploy Preview for astral-prod ready!

    Name Link
    🔨 Latest commit 893cdef
    🔍 Latest deploy log https://app.netlify.com/sites/astral-prod/deploys/663e1c949d41f90008644fa0
    😎 Deploy Preview https://deploy-preview-585--astral-prod.netlify.app
    📱 Preview on mobile
    Toggle QR Code...

    QR Code

    Use your smartphone camera to open QR code link.

    To edit notification comments on pull requests, go to your Netlify site configuration.

    Copy link

    netlify bot commented May 10, 2024

    Deploy Preview for storybook-pr failed. Why did it fail? →

    Name Link
    🔨 Latest commit 893cdef
    🔍 Latest deploy log https://app.netlify.com/sites/storybook-pr/deploys/663e1c94763b5c0008b68023

    Copy link

    socket-security bot commented May 10, 2024

    No dependency changes detected. Learn more about Socket for GitHub ↗︎

    👍 No dependency changes detected in pull request

    @github-actions github-actions bot added the enhancement New feature or request label May 10, 2024
    Copy link

    PR Description updated to latest commit (d85ca27)

    Copy link

    PR Review 🔍

    ⏱️ Estimated effort to review [1-5]

    2, because the PR mainly involves deletion of files and a simple update in the workflow configuration. The changes are straightforward and do not involve complex logic or new functionality.

    🧪 Relevant tests

    No

    ⚡ Possible issues

    No

    🔒 Security concerns

    No

    Code feedback:
    relevant file.github/workflows/build.yaml
    suggestion      

    Ensure that all dependencies and scripts in the 'explorer' directory are correctly configured to replace the 'client' directory. This includes checking package.json, any build scripts, and ensuring all paths in the workflow are correctly updated. [important]

    relevant lineworking-directory: explorer

    relevant file.github/workflows/build.yaml
    suggestion      

    Consider adding a step in the GitHub Actions workflow to verify that the transition from 'client' to 'explorer' does not break any existing functionality. This could be a script that checks for critical files or runs a small suite of integration tests. [important]

    relevant linets-lint-and-build-explorer:

    relevant file.github/workflows/build.yaml
    suggestion      

    Since the 'client' directory is removed, ensure that any references to environment variables or paths specific to the 'client' setup are also updated or removed in the GitHub Actions environment settings. [medium]

    relevant lineworking-directory: explorer

    relevant file.github/workflows/build.yaml
    suggestion      

    Verify that all necessary caching mechanisms (e.g., node_modules) are correctly configured for the 'explorer' directory in the GitHub Actions workflow to optimize build times. [medium]

    relevant lineworking-directory: explorer

    Copy link

    PR Code Suggestions ✨

    CategorySuggestions                                                                                                                                                       
    Possible issue
    Review and justify the inclusion of lastBlock in the dependency array.

    Ensure that the lastBlock variable is used within the component or remove it from the
    dependency array if it's not affecting the rendering or logic. Unused dependencies in the
    array can lead to unnecessary re-renders or confusion about the component's reactive
    properties.

    explorer/src/components/Operator/OperatorsListCard.tsx [80]

    -}, [
    +}, [  // Assuming `lastBlock` is now used or removed based on its necessity
       actingAccount,
       action,
    -  lastBlock,
       excludeActions,
       handleAction,
       nominatorMaxStake,
     
    Enhancement
    Correct the job name in the GitHub Actions workflow to match the intended directory.

    Update the job name from ts-lint-and-build-explorer to ts-lint-and-build-client to reflect
    the correct directory and purpose, especially if the client directory is still relevant.
    This helps maintain clarity in CI/CD pipeline configurations.

    .github/workflows/build.yaml [21-25]

    -ts-lint-and-build-explorer:
    +ts-lint-and-build-client:  # Corrected job name
       runs-on: ubuntu-latest
       defaults:
         run:
    -      working-directory: explorer
    +      working-directory: client
     
    Maintainability
    Verify and update external dependencies and references due to the removal of the client directory.

    Since the client directory is being removed, ensure that any references or dependencies in
    other projects or configurations that rely on the client directory are updated or removed
    to prevent broken links or errors.

    .vscode/astral.code-workspace [13]

     {
       "name": "health-check",
       "path": "../health-check"
    -}
    +}  # Ensure no other project components depend on the removed 'client' directory
     

    jfrank-summit
    jfrank-summit previously approved these changes May 21, 2024
    @marc-aurele-besner marc-aurele-besner changed the base branch from main to staging May 21, 2024 20:12
    @marc-aurele-besner marc-aurele-besner dismissed jfrank-summit’s stale review May 21, 2024 20:12

    The base branch was changed.

    Copy link

    netlify bot commented May 21, 2024

    Deploy Preview for dev-astral ready!

    Name Link
    🔨 Latest commit 7c6d5ea
    🔍 Latest deploy log https://app.netlify.com/sites/dev-astral/deploys/664d01245111070009186300
    😎 Deploy Preview https://deploy-preview-585--dev-astral.netlify.app
    📱 Preview on mobile
    Toggle QR Code...

    QR Code

    Use your smartphone camera to open QR code link.

    To edit notification comments on pull requests, go to your Netlify site configuration.

    @marc-aurele-besner marc-aurele-besner merged commit 150f806 into staging May 21, 2024
    13 checks passed
    @marc-aurele-besner marc-aurele-besner deleted the 584-remove-deprecated-react-explorer branch May 21, 2024 20:32
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    Remove deprecated react explorer
    2 participants