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

[FIX] Custom script addition in header #469

Merged
merged 4 commits into from
Jan 30, 2025
Merged

Conversation

surchs
Copy link
Contributor

@surchs surchs commented Jan 30, 2025

Changes proposed in this pull request:

  • move placeholder to head tag (where it should have been)
  • fix the placeholder comment in the GH workflow because we updated it in index.html but forgot to also update in GH wf

NOTE: If this pull request is to be released, the release label must be applied once the review process is done to avoid the local and remote from going out of sync as a consequence of the bump version workflow run

Checklist

This section is for the PR reviewer

  • PR has an interpretable title with a prefix ([ENH], [FIX], [REF], [TST], [CI], [MNT], [INF], [MODEL], [DOC]) (see our Contributing Guidelines for more info)
  • PR has a label for the release changelog or skip-release (to be applied by maintainers only)
  • PR links to GitHub issue with mention Closes #XXXX
  • Tests pass
  • Checks pass
  • If the PR changes the participant-level and/or the dataset-level result file, the query-tool-results files in the neurobagel_examples repo have been regenerated

For new features:

  • Tests have been added

For bug fixes:

  • There is at least one test that would fail under the original bug conditions.

Summary by Sourcery

Bug Fixes:

  • Correct the placeholder comment in the GitHub workflow to match the updated placeholder in index.html.

surchs and others added 3 commits January 30, 2025 14:48
That's where we thought they were going all along. But then we added
them to the body and they still worked, so apparently we forgot about
it.
Copy link

sourcery-ai bot commented Jan 30, 2025

Reviewer's Guide by Sourcery

This pull request moves the custom script addition from the body to the head tag in index.html and updates the GitHub workflow to reflect this change.

Sequence diagram for script loading in HTML page

sequenceDiagram
    participant Browser
    participant HTML
    participant Scripts
    Note over Browser,Scripts: Before PR: Scripts loaded in body
    Browser->>HTML: Request page
    HTML->>Browser: Load HTML structure
    Browser->>Scripts: Load tracking scripts (in body)
    Note over Browser,Scripts: After PR: Scripts loaded in head
    Browser->>HTML: Request page
    HTML->>Scripts: Load tracking scripts (in head)
    HTML->>Browser: Load HTML structure
Loading

File-Level Changes

Change Details Files
Move custom script placeholder to the head tag.
  • Moved the placeholder comment from the body to the head tag.
index.html
Update the GitHub workflow to use the new placeholder location.
  • Updated the sed command to replace the placeholder in the head tag instead of the body tag.
.github/workflows/deploy.yaml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@surchs surchs requested a review from rmanaem January 30, 2025 19:51
Copy link

netlify bot commented Jan 30, 2025

Deploy Preview for neurobagel-query ready!

Name Link
🔨 Latest commit 69309d4
🔍 Latest deploy log https://app.netlify.com/sites/neurobagel-query/deploys/679bd8a900e704000831301c
😎 Deploy Preview https://deploy-preview-469--neurobagel-query.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.

@surchs surchs added pr-internal Non-user-facing code improvement, will increment patch version when merged (0.0.+1) release Create a release when this PR is merged labels Jan 30, 2025
Copy link
Contributor

@rmanaem rmanaem left a comment

Choose a reason for hiding this comment

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

🧑‍🍳

@surchs surchs merged commit 1dad103 into main Jan 30, 2025
14 checks passed
@surchs surchs deleted the correct_script_addition branch January 30, 2025 19:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr-internal Non-user-facing code improvement, will increment patch version when merged (0.0.+1) release Create a release when this PR is merged
Projects
Status: Review - Done
Development

Successfully merging this pull request may close these issues.

2 participants