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

Using changesets to update Announcement.tsx #350

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

a8trejo
Copy link

@a8trejo a8trejo commented Jan 13, 2025

Description

Using changesets to update Announcement.tsx

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Checklist:

  • My code follows the patterns of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation

Additional context

Related Issues

Reviewers


Important

Automate updates to Announcement.tsx and latestAnnouncementId in ClineProvider.ts using new scripts and modify workflow to run these scripts for major/minor version changes.

  • Scripts:
    • Add update-announcement-id.py to update latestAnnouncementId in ClineProvider.ts.
    • Add update-announcement.js to update Announcement.tsx with latest changelog entry.
  • Workflow:
    • Modify changeset-release.yml to run new scripts for major/minor version changes.
    • Add step to format Announcement.tsx using Prettier.
  • Components:
    • Update Announcement.tsx to use full version number.
  • Misc:
    • Add markdown-to-jsx dependency in package.json.

This description was created by Ellipsis for 9a78b05. It will automatically update as commits are pushed.

Copy link

changeset-bot bot commented Jan 13, 2025

⚠️ No Changeset found

Latest commit: 9a78b05

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

@a8trejo a8trejo marked this pull request as ready for review January 13, 2025 23:34
import os
import re

VERSION = os.environ['VERSION']
Copy link

Choose a reason for hiding this comment

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

Consider adding error handling for the case where the VERSION environment variable is not set to prevent a KeyError.


// Convert changelog entry to JSX-friendly format
const formattedContent = convertMarkdownToJsx(changelogEntry);
formattedContent.replace('{" "}', "")
Copy link

Choose a reason for hiding this comment

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

The line formattedContent.replace('{" "}', "") does not modify formattedContent as strings are immutable. Consider reassigning the result to formattedContent.

@mrubens
Copy link
Collaborator

mrubens commented Jan 17, 2025

Heads up that I ran prettier on the whole codebase in #404, and it will run automatically in a pre-commit hook going forward.

In order to bring this PR up to date on formatting you'll need to run npx prettier './**/*.{js,jsx,ts,tsx,json,css,md}' --write. Sorry for any hassle with this, and let me know if you get stuck!

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