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

docs: update script to fix copying issue #20720

Merged
merged 2 commits into from
Jun 19, 2024
Merged

docs: update script to fix copying issue #20720

merged 2 commits into from
Jun 19, 2024

Conversation

samricotta
Copy link
Contributor

@samricotta samricotta commented Jun 18, 2024

Description

Closes: #XXXX

Updates folder placement for documentation as some of the files are being imported to the wrong place


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title, you can find examples of the prefixes below:
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • updated the relevant documentation or specification, including comments for documenting Go code
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

  • Chores
    • Updated internal file paths for module documentation.

Copy link
Contributor

@testinginprod testinginprod left a comment

Choose a reason for hiding this comment

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

lgtm

Copy link
Contributor

coderabbitai bot commented Jun 19, 2024

Walkthrough

Walkthrough

This update modifies the MODULE_DIRECTORY path in the docs/pre.sh script. The path has been changed from build/modules/$DIR_NAME to docs/build/modules/$DIR_NAME. This adjustment ensures that the module directories are correctly nested under the docs folder, reflecting an updated directory structure for better organization.

Changes

File Change Summary
docs/pre.sh Updated MODULE_DIRECTORY path from build/modules/$DIR_NAME to docs/build/modules/$DIR_NAME.

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

@samricotta samricotta enabled auto-merge June 19, 2024 08:02
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: 1

Outside diff range and nitpick comments (1)
docs/pre.sh (1)

Line range hint 18-18: There's a TODO comment related to issue #9958. Ensure that this issue is actively being addressed to prevent it from becoming stale.

Would you like me to help with resolving this or should I open a reminder issue on GitHub?

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 55821b3 and b825067.

Files selected for processing (1)
  • docs/pre.sh (1 hunks)

@@ -7,7 +7,7 @@ for D in ../x/*; do

# Skip specific directories
if [[ "$DIR_NAME" != "counter" ]]; then
MODULE_DIRECTORY=build/modules/$DIR_NAME
MODULE_DIRECTORY=docs/build/modules/$DIR_NAME
Copy link
Contributor

Choose a reason for hiding this comment

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

Tip

Codebase Verification

The search results indicate that the new path MODULE_DIRECTORY=docs/build/modules is only present in docs/pre.sh, and there are no references to the old path MODULE_DIRECTORY=build/modules elsewhere in the repository.

  • docs/pre.sh: MODULE_DIRECTORY=docs/build/modules/$DIR_NAME

This suggests that the updated path is not used consistently across the project. Please review and update all relevant references to ensure consistency.

Analysis chain

The updated MODULE_DIRECTORY path looks correct for the intended fix. Please ensure that all references to this path elsewhere in the project have been updated accordingly.

Scripts executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify all references to `MODULE_DIRECTORY` use the new path.

# Search for the old path and the new path to ensure consistency.
rg --type bash 'MODULE_DIRECTORY=build/modules'
rg --type bash 'MODULE_DIRECTORY=docs/build/modules'

Length of output: 158



Script:

#!/bin/bash
# Description: Verify all references to `MODULE_DIRECTORY` use the new path.

# Search for the old path and the new path to ensure consistency.
rg 'MODULE_DIRECTORY=build/modules'
rg 'MODULE_DIRECTORY=docs/build/modules'

Length of output: 140

@samricotta samricotta added this pull request to the merge queue Jun 19, 2024
Merged via the queue into main with commit b48fd66 Jun 19, 2024
63 of 64 checks passed
@samricotta samricotta deleted the sam/pre-script-docs branch June 19, 2024 08:10
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.

5 participants