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.

Sign up for GitHub

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

Jump to bottom

docs: avoid copying non existent files & counter readme #18487

Merged
merged 4 commits into from
Nov 16, 2023
Merged

docs: avoid copying non existent files & counter readme #18487

merged 4 commits into from
Nov 16, 2023

Conversation

tac0turtle
Copy link
Member

@tac0turtle tac0turtle commented Nov 16, 2023 •
edited by coderabbitai bot
Loading

Description

this pr avoids counter from being included in docs to avoid confusion, at the same time it doesnt try to copy tx and simulation because they dont exist

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
  • added ! to 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
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • run make lint and make test
  • 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.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

Summary by CodeRabbit

  • Documentation
    • Improved the documentation generation script to selectively skip certain directories, ensuring a more relevant and streamlined documentation structure for end-users.

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 16, 2023 •
edited
Loading

Warning

Rate Limit Exceeded

@tac0turtle has exceeded the limit for the number of files or commits that can be reviewed per hour. Please wait 3 minutes and 59 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per repository.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits Files that changed from the base of the PR and between 09a113c and 9103455.
Walkthrough

Walkthrough

The shell script pre.sh has been updated to dynamically exclude certain directories from documentation generation. Instead of hardcoding the directories to skip, the script now checks the name of each directory and conditionally processes only those that do not match the names "counter", "tx", or "simulation". For all other directories, it copies the README.md file into a new documentation structure within the build directory.

Changes

File Path Change Summary
docs/pre.sh Updated to conditionally exclude "counter", "tx", and "simulation" directories from documentation generation, copying README.md files to the build directory for other modules.
Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • If you reply to a review comment from CodeRabbit, the bot will automatically respond.
  • To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment
  • Note: Review comments are made on code diffs or files, not on the PR overview.
  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Note: For conversation with the bot, please use the review comments on code diffs or files.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

@tac0turtle tac0turtle changed the title avoid counter and other missing readmes in script docs: avoid counter and other missing readmes in script Nov 16, 2023
coderabbitai[bot]
coderabbitai bot reviewed Nov 16, 2023
View reviewed changes
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.

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 3853e7f and 4486403.
Files selected for processing (1)
  • docs/pre.sh (1 hunks)

docs/pre.sh Outdated Show resolved Hide resolved
coderabbitai[bot]
coderabbitai bot reviewed Nov 16, 2023
View reviewed changes
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.

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 4486403 and 09a113c.
Files selected for processing (1)
  • docs/pre.sh (1 hunks)

docs/pre.sh Outdated Show resolved Hide resolved
@tac0turtle tac0turtle changed the title docs: avoid counter and other missing readmes in script docs: avoid copying non existent files Nov 16, 2023
@tac0turtle tac0turtle changed the title docs: avoid copying non existent files docs: avoid copying non existent files & counter readme Nov 16, 2023
julienrbrt
julienrbrt approved these changes Nov 16, 2023
View reviewed changes
Copy link
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

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

utACK

@tac0turtle tac0turtle added this pull request to the merge queue Nov 16, 2023
Merged via the queue into main with commit 7a28425 Nov 16, 2023
48 of 55 checks passed
@tac0turtle tac0turtle deleted the marko/avoid_counter branch November 16, 2023 14:44
@tac0turtle
Copy link
Member Author

@Mergifyio backport release/v0.50.x

@mergify Mergify
Copy link
Contributor

mergify bot commented Nov 16, 2023 •
edited
Loading

backport release/v0.50.x

✅ Backports have been created

mergify bot pushed a commit that referenced this pull request Nov 16, 2023
@tac0turtle @mergify
docs: avoid copying non existent files & counter readme (#18487)
5dd0ba7 
(cherry picked from commit 7a28425)

# Conflicts:
#	docs/pre.sh
@mergify mergify bot mentioned this pull request Nov 16, 2023
Merged
tac0turtle added a commit that referenced this pull request Nov 16, 2023
@mergify @tac0turtle
docs: avoid copying non existent files & counter readme (backport #18487
2e48b8e 
) (#18490)

Co-authored-by: Marko <marbar3778@yahoo.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai coderabbitai left review comments

@julienrbrt julienrbrt julienrbrt approved these changes

@samricotta samricotta Awaiting requested review from samricotta

Assignees

@julienrbrt julienrbrt

@samricotta samricotta

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@tac0turtle @julienrbrt @samricotta