Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Fix doc artifact name #1004

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
Merged
merged 2 commits into from
Apr 4, 2024
Merged

Fix doc artifact name #1004

merged 2 commits into from
Apr 4, 2024

Conversation

kamiazya
Copy link
Member

@kamiazya kamiazya commented Apr 4, 2024 •
edited by coderabbitai bot
Loading

This pull request fixes the artifact name for the doc folder. Previously, it was not correctly named, causing confusion. Now, the artifact name is set to "doc" to accurately reflect the contents of the folder.

Summary by CodeRabbit

  • Chores
    • Improved artifact naming for documentation in CI workflows.

@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Apr 4, 2024 •
edited
Loading

🦋 Changeset detected

Latest commit: ed74fb1

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 6 packages
Name Type
@ts-graphviz/adapter Patch
@ts-graphviz/ast Patch
@ts-graphviz/common Patch
@ts-graphviz/core Patch
@ts-graphviz/react Patch
ts-graphviz Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Apr 4, 2024 •
edited
Loading

Warning

Rate Limit Exceeded

@kamiazya has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 23 minutes and 33 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 as a PR comment. 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 organization.
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 d84f9df and ed74fb1.

Walkthrough

The update introduces a minor yet significant enhancement to the workflow configuration by adding a name: doc parameter to the artifact upload section. This change likely aims to improve the organization and identification of artifacts within the CI/CD pipeline, specifically targeting documentation or related artifacts.

Changes

File Path Change Summary
.github/workflows/.build.yaml Added name: doc parameter for artifact uploads.

🐰✨
In the realm of code, where the bits gently hop,
A small change lands, with a soft, silent plop.
name: doc now stands, in the workflow's heart,
Guiding artifacts home, a small but crucial part.
So here's to the change, may it smoothly embark,
On a journey of bytes, through the digital dark.
🌟🐾

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.

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

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/coderabbit-overrides.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.

@kamiazya kamiazya self-assigned this Apr 4, 2024
coderabbitai[bot]
coderabbitai bot reviewed Apr 4, 2024
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.

Actionable comments posted: 0

Review Status

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 24f4174 and d84f9df.
Files selected for processing (1)
  • .github/workflows/.build.yaml (1 hunks)
Additional comments not posted (1)
.github/workflows/.build.yaml (1)

45-45: The change to set the artifact name to "doc" is appropriate and aligns with the PR's objective to correct the naming of the documentation artifact.

However, ensure that the doc directory is indeed the output of the documentation build step and that this naming convention is consistent with other artifacts in the project.

@kamiazya kamiazya merged commit fabb8c8 into main Apr 4, 2024
@github-actions github-actions bot mentioned this pull request Apr 4, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

Assignees

@kamiazya kamiazya

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@kamiazya