Skip to content

Updated the Flatfile importer#421

Merged
sriramveeraghanta merged 2 commits intomasterfrom
update-flatfile-mporter
Mar 27, 2026
Merged

Updated the Flatfile importer#421
sriramveeraghanta merged 2 commits intomasterfrom
update-flatfile-mporter

Conversation

@danciaclara
Copy link
Copy Markdown
Collaborator

@danciaclara danciaclara commented Mar 27, 2026

Description

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • Feature (non-breaking change which adds functionality)
  • Improvement (change that would cause existing functionality to not work as expected)
  • Code refactoring
  • Performance improvements
  • Documentation update

Screenshots and Media (if applicable)

Test Scenarios

References

Summary by CodeRabbit

  • Documentation
    • Added guidance to save CSVs with UTF-8 encoding and updated CSV Importer screenshots.
    • Expanded Flatfile importer docs with a full CSV-to-Plane workflow: project selection, UTF-8 sample CSV, header-to-field mapping, validation for fields like State/Priority, preview/review, migration tracking with re-run/cancel, and an import management section.
    • Clarified Free-trial-to-Free-plan billing behavior and no-charge scenarios.

@vercel
Copy link
Copy Markdown

vercel bot commented Mar 27, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Mar 27, 2026 0:19am

Request Review

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 27, 2026

📝 Walkthrough

Walkthrough

Documentation updates across three areas: CSV importer guidance now includes UTF-8 encoding instructions with an updated screenshot reference; Flatfile importer docs expanded with a complete CSV-to-Plane workflow, field mapping rules, and import management details; billing docs clarify free-trial-to-Free-plan transition and billing behavior.

Changes

Cohort / File(s) Summary
CSV Importer Documentation
docs/importers/csv.md
Added instruction to save CSVs with UTF-8 encoding and updated the CSV Importer screenshot URL path.
Flatfile Importer Documentation
docs/importers/flatfile.md
Expanded to describe end-to-end CSV-to-Plane import flow: project selection, UTF-8 CSV upload (with sample template), header-to-field mapping, value validation for fields (e.g., State, Priority), preview and submission, migration tracking via Migrations list, and a new "Managing your imports" section including re-run/cancel actions. Adjusted field naming/casing and added Target Date requirement.
Billing Documentation
docs/workspaces-and-users/billing-and-plans.md
Clarified that after a 14-day free trial, the workspace reverts to the Free plan if not upgraded and explicitly states no charges occur when no payment method was ever added.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 I hopped through docs with a pencil and grin,

UTF-8 stitched where files begin,
Flatfile paths folded neat and true,
Trials settle to Free—no surprise to you,
I thumped my foot and said, "All done!" 🥕

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Title check ⚠️ Warning The title only partially represents the changeset, which includes updates to Flatfile documentation, CSV documentation, and billing documentation. While the title mentions Flatfile, it omits the other significant documentation updates. Consider a more comprehensive title that reflects all major changes, such as 'Update importers and billing documentation' or 'Update Flatfile, CSV importer, and billing docs'.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch update-flatfile-mporter

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@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: 2

🧹 Nitpick comments (1)
docs/workspaces-and-users/billing-and-plans.md (1)

153-153: Consider clarifying the billing behavior for all trial scenarios.

The sentence structure leaves ambiguous what happens if a payment method was added during the trial but no upgrade occurred. The conditional phrase "if a payment method was never added" implies there might be a different outcome when one was added, but that scenario isn't addressed.

Consider restructuring for clarity:

📝 Suggested improvement for clarity

Option 1 - Address both scenarios explicitly:

-After 14 days, your workspace automatically reverts to the Free plan if you haven't upgraded to a paid subscription, and you won't be charged if a payment method was never added.
+After 14 days, your workspace automatically reverts to the Free plan if you haven't upgraded to a paid subscription. No charges are applied since the trial doesn't require a payment method.

Option 2 - Split into separate sentences:

-After 14 days, your workspace automatically reverts to the Free plan if you haven't upgraded to a paid subscription, and you won't be charged if a payment method was never added.
+After 14 days, your workspace automatically reverts to the Free plan if you haven't upgraded to a paid subscription. Since no payment method is required for the trial, you won't be charged.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/workspaces-and-users/billing-and-plans.md` at line 153, The sentence
"After 14 days, your workspace automatically reverts to the Free plan if you
haven't upgraded to a paid subscription, and you won’t be charged if a payment
method was never added." is ambiguous about the case where a payment method was
added during the trial but no upgrade occurred; rewrite the line (the sentence
starting with "After 14 days...") to explicitly cover both outcomes—e.g., state
that the workspace reverts to Free after 14 days and that users will not be
charged unless they actively upgrade to a paid subscription (clarify that having
a payment method on file does not trigger a charge), or split into two sentences
that separately state the automatic reversion and the charging behavior
depending on whether the user upgraded.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/importers/flatfile.md`:
- Line 122: Update the table cell that currently reads "Created By | **Must be
email addresses** - allows Plane to track who originally created the item" to
the tightened wording "Created By | **Must be email addresses** - allows Plane
to track who created the item"; locate the string in docs/importers/flatfile.md
(the "Created By" table row) and replace the redundant phrase "originally
created the item" with "created the item".
- Around line 46-50: Remove trailing whitespace on the line containing the
"Sample CSV template" tip link and delete the whitespace-only blank line
immediately after it so the markdown block contains no trailing or blank-only
lines; locate the tip block that starts with "::: tip Sample CSV template" and
the link to "sample CSV file" and clean up the two offending whitespace
characters to satisfy the formatter.

---

Nitpick comments:
In `@docs/workspaces-and-users/billing-and-plans.md`:
- Line 153: The sentence "After 14 days, your workspace automatically reverts to
the Free plan if you haven't upgraded to a paid subscription, and you won’t be
charged if a payment method was never added." is ambiguous about the case where
a payment method was added during the trial but no upgrade occurred; rewrite the
line (the sentence starting with "After 14 days...") to explicitly cover both
outcomes—e.g., state that the workspace reverts to Free after 14 days and that
users will not be charged unless they actively upgrade to a paid subscription
(clarify that having a payment method on file does not trigger a charge), or
split into two sentences that separately state the automatic reversion and the
charging behavior depending on whether the user upgraded.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 26e01c86-0bde-431a-bd6b-1b6cbb0e3e5e

📥 Commits

Reviewing files that changed from the base of the PR and between e7e1f0a and d8d997c.

📒 Files selected for processing (3)
  • docs/importers/csv.md
  • docs/importers/flatfile.md
  • docs/workspaces-and-users/billing-and-plans.md

| State | Must map to valid states in your Plane project |
| Assignees | **Must be email addresses**, not usernames - this is how Plane connects work items to users |
| Priority | Must map to valid priority values in your Plane project |
| Created By | **Must be email addresses** - allows Plane to track who originally created the item |
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Tighten redundant phrasing in field note.

Line 122 reads a bit verbose (“originally created the item”). Consider “track who created the item” for clarity and brevity.

🧰 Tools
🪛 LanguageTool

[style] ~122-~122: This phrase is redundant. Consider writing “created”.
Context: ...addresses** - allows Plane to track who originally created the item | | St...

(ORIGINALLY_CREATED)

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/importers/flatfile.md` at line 122, Update the table cell that currently
reads "Created By | **Must be email addresses** - allows Plane to track who
originally created the item" to the tightened wording "Created By | **Must be
email addresses** - allows Plane to track who created the item"; locate the
string in docs/importers/flatfile.md (the "Created By" table row) and replace
the redundant phrase "originally created the item" with "created the item".

Copy link
Copy Markdown

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

♻️ Duplicate comments (1)
docs/importers/flatfile.md (1)

120-120: ⚠️ Potential issue | 🟡 Minor

Tighten redundant phrasing.

The phrase "originally created the item" is redundant. Consider "track who created the item" for clarity and brevity.

✂️ Proposed simplification
-| Created By     | **Must be email addresses** - allows Plane to track who originally created the item                         |
+| Created By     | **Must be email addresses** - allows Plane to track who created the item                                    |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/importers/flatfile.md` at line 120, Update the table cell text to remove
redundant phrasing: replace "allows Plane to track who originally created the
item" with "allows Plane to track who created the item" so the full row reads
"Created By | **Must be email addresses** - allows Plane to track who created
the item"; keep the emphasis and requirement about email addresses unchanged.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Duplicate comments:
In `@docs/importers/flatfile.md`:
- Line 120: Update the table cell text to remove redundant phrasing: replace
"allows Plane to track who originally created the item" with "allows Plane to
track who created the item" so the full row reads "Created By | **Must be email
addresses** - allows Plane to track who created the item"; keep the emphasis and
requirement about email addresses unchanged.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: e34522e6-d9e4-41a2-885c-01ad381d8f12

📥 Commits

Reviewing files that changed from the base of the PR and between d8d997c and 7f8cbc9.

📒 Files selected for processing (1)
  • docs/importers/flatfile.md

@sriramveeraghanta sriramveeraghanta merged commit 9e68318 into master Mar 27, 2026
5 checks passed
@sriramveeraghanta sriramveeraghanta deleted the update-flatfile-mporter branch March 27, 2026 12:24
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.

2 participants