FlatFilers / Guides

Flatfile's Documentation
7 stars 20 forks source link

Add auto-update changelog files from changelog/** branches action #1161

Open meritmalling opened 6 days ago

coderabbitai[bot] commented 3 days ago

[!WARNING]

Rate limit exceeded

@meritmalling has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 26 minutes and 5 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](https://coderabbit.ai/docs/faq) for further information.
Commits Files that changed from the base of the PR and between 9692710617a293499d7109c013a891b332303fab and 3e957df92dad05bdaac001c7f4cc7f743ae14a04.

Walkthrough

Automates the process of updating the changelog in the repository. Introduces a GitHub Actions workflow (update-changelog.yml) to manage changelog updates triggered by pull request events. It utilizes a changelog/bin/update.js script to aggregate and format changelog entries from various MDX files into a single document, ensuring each entry is properly categorized and timestamped.

Changes

Files Change Summaries
.github/workflows/update-changelog.yml Adds GitHub Actions workflow to automate changelog updates based on PR events.
changelog/bin/update.js Introduces a script that combines MDX files, adding headers and categorizing changes.
changelog/src/libraries/06122024.mdx Describes enhancements in flatfile version 3.7.0 related to file upload handling and event topics.
changelog/src/platform/06062024.mdx Adds Resend User Invite endpoint functionality on June 6, 2024.
changelog/src/platform/06072024.mdx Details new features: Select Header Row and Search for Users, introduced on June 7, 2024.
changelog/src/plugins/0412.2024.mdx Introduces @flatfile/plugin-graphql-schema@1.0.0 with GraphQL to Flatfile Blueprint functionality.
changelog/src/test/06272024.mdx Adds a placeholder entry for flatfile/changelog on June 27, 2024.

Sequence Diagrams

sequenceDiagram
    participant Dev as Developer
    participant GitHub as GitHub
    participant Action as update-changelog.yml
    participant Script as update.js

    Dev->>GitHub: Create/Modify Pull Request
    GitHub->>Action: Trigger Workflow
    Action->>Script: Check for changelog/src changes
    Script->>Script: Install dependencies and run changelog script
    Script->>GitHub: Commit updated changelog
    GitHub->>Dev: Notify of changelog update

Possibly related issues


[!TIP]

Early access features: disabled We are currently testing the following features in early access: - **OpenAI `gpt-4o` model for code reviews and chat**: OpenAI claims that this model is better at understanding and generating code than the previous models. We seek your feedback over the next few weeks before making it generally available. Note: - You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file. - Please join our [Discord Community](https://discord.com/invite/GsXnASn26c) to provide feedback and report issues. - OSS projects are currently opted into early access features by default.
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.