Merge pull request #61 from RooVetGit/chores/changeset-releases

Changeset AI Releases and code guardrails

Author: a8trejo

.changeset/README.md

@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

.changeset/config.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://unpkg.com/@changesets/[email protected]/schema.json",
+  "changelog": "@changesets/cli/changelog",
+  "commit": false,
+  "fixed": [],
+  "linked": [],
+  "access": "restricted",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": []
+}

.github/pull_request_template.md

@@ -0,0 +1,28 @@
+<!-- **Note:** Consider creating PRs as a DRAFT. For early feedback and self-review. -->
+## Description
+
+## Type of change
+<!-- Please ignore options that are not relevant -->
+- [ ] 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?
+<!-- Please describe the tests that you ran to verify your changes -->
+
+## Checklist:
+<!-- Go over all the following points, and put an `x` in all the boxes that apply -->
+- [ ] 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
+<!-- Add any other context or screenshots about the pull request here -->
+
+## Related Issues
+<!-- List any related issues here. Use the GitHub issue linking syntax: #issue-number -->
+
+## Reviewers
+<!-- @mention specific team members or individuals who should review this PR -->

.github/scripts/overwrite_changeset_changelog.py

@@ -0,0 +1,60 @@
+"""
+This script updates a specific version's release notes section in CHANGELOG.md with new content.
+
+The script:
+1. Takes a version number, changelog path, and new content as input from environment variables
+2. Finds the section in the changelog for the specified version
+3. Replaces the content between the current version header and the next version header
+   (or end of file if it's the latest version) with the new content
+4. Writes the updated changelog back to the file
+
+Environment Variables:
+    CHANGELOG_PATH: Path to the changelog file (defaults to 'CHANGELOG.md')
+    VERSION: The version number to update notes for
+    PREV_VERSION: The previous version number (optional)
+    NEW_CONTENT: The new content to insert for this version
+"""
+
+#!/usr/bin/env python3
+
+import os
+
+CHANGELOG_PATH = os.environ.get("CHANGELOG_PATH", "CHANGELOG.md")
+VERSION = os.environ['VERSION']
+PREV_VERSION = os.environ.get("PREV_VERSION", "")
+NEW_CONTENT = os.environ['NEW_CONTENT']
+
+def overwrite_changelog_section(content: str):    
+    """Replace a specific version section in the changelog content.
+    
+    Args:
+        content: The full changelog content as a string
+        
+    Returns:
+        The updated changelog content with the new section
+        
+    Example:
+        >>> content = "## 1.2.0\\nOld changes\\n## 1.1.0\\nOld changes"
+        >>> NEW_CONTENT = "New changes"
+        >>> overwrite_changelog_section(content)
+        '## 1.2.0\\nNew changes\\n## 1.1.0\\nOld changes'
+    """
+    # Find the section for the specified version
+    version_pattern = f"## {VERSION}\n"
+    print(f"latest version: {VERSION}")
+    notes_start_index = content.find(version_pattern) + len(version_pattern)
+    print(f"prev_version: {PREV_VERSION}")
+    prev_version_pattern = f"## {PREV_VERSION}\n"
+    notes_end_index = content.find(prev_version_pattern, notes_start_index) if PREV_VERSION and prev_version_pattern in content else len(content)
+    return content[:notes_start_index] + f"{NEW_CONTENT}\n" + content[notes_end_index:]
+
+with open(CHANGELOG_PATH, 'r') as f:
+    content = f.read()
+
+new_changelog = overwrite_changelog_section(content)
+
+print(new_changelog)
+
+# Write back to CHANGELOG.md
+with open(CHANGELOG_PATH, 'w') as f:
+    f.write(new_changelog)

.github/scripts/parse_changeset_changelog.py

@@ -0,0 +1,64 @@
+"""
+This script extracts the release notes section for a specific version from CHANGELOG.md.
+
+The script:
+1. Takes a version number and changelog path as input from environment variables
+2. Finds the section in the changelog for the specified version
+3. Extracts the content between the current version header and the next version header
+   (or end of file if it's the latest version)
+4. Outputs the extracted release notes to GITHUB_OUTPUT for use in creating GitHub releases
+
+Environment Variables:
+    GITHUB_OUTPUT: Path to GitHub Actions output file
+    CHANGELOG_PATH: Path to the changelog file (defaults to 'CHANGELOG.md')
+    VERSION: The version number to extract notes for
+"""
+
+#!/usr/bin/env python3
+
+import sys
+import os
+import subprocess
+
+GITHUB_OUTPUT = os.getenv("GITHUB_OUTPUT")
+CHANGELOG_PATH = os.environ.get("CHANGELOG_PATH", "CHANGELOG.md")
+VERSION = os.environ['VERSION']
+
+def parse_changelog_section(content: str):
+    """Parse a specific version section from the changelog content.
+    
+    Args:
+        content: The full changelog content as a string
+        
+    Returns:
+        The formatted content for this version, or None if version not found
+        
+    Example:
+        >>> content = "## 1.2.0\\nChanges\\n## 1.1.0\\nOld changes"
+        >>> parse_changelog_section(content)
+        'Changes\\n'
+    """
+    # Find the section for the specified version
+    version_pattern = f"## {VERSION}\n"
+    print(f"latest version: {VERSION}")
+    notes_start_index = content.find(version_pattern) + len(version_pattern)
+    prev_version = subprocess.getoutput("git show origin/main:package.json | grep '\"version\":' | cut -d'\"' -f4")
+    print(f"prev_version: {prev_version}")
+    prev_version_pattern = f"## {prev_version}\n"
+    notes_end_index = content.find(prev_version_pattern, notes_start_index) if prev_version_pattern in content else len(content)
+
+    return content[notes_start_index:notes_end_index]
+
+with open(CHANGELOG_PATH, 'r') as f:
+    content = f.read()
+
+formatted_content = parse_changelog_section(content)
+if not formatted_content:
+    print(f"Version {VERSION} not found in changelog", file=sys.stderr)
+    sys.exit(1)
+
+print(formatted_content)
+
+# Write the extracted release notes to GITHUB_OUTPUT
+with open(GITHUB_OUTPUT, "a") as gha_output:
+    gha_output.write(f"release-notes<<EOF\n{formatted_content}\nEOF")

.github/scripts/release-notes-prompt.py

@@ -0,0 +1,23 @@
+"""
+This script generates a base prompt for OpenAI to create release notes.
+"""
+
+#!/usr/bin/env python3
+
+import os
+from datetime import datetime;
+from pytz import timezone
+
+GITHUB_OUTPUT = os.getenv("GITHUB_OUTPUT")
+
+TODAY = datetime.now(timezone('US/Eastern')).isoformat(sep=' ', timespec='seconds')
+
+BASE_PROMPT = f"""Based on the following 'PR Information', please generate concise and informative release notes to be read by developers.
+Format the release notes with markdown, and always use this structure: a descriptive and very short title (no more than 8 words) with heading level 2, a paragraph with a summary of changes (no header), and if applicable, sections for '🚀 New Features & Improvements', '🐛 Bugs Fixed' and '🔧 Other Updates', with heading level 3, skip respectively the sections if not applicable. 
+Finally include the following markdown comment with the PR merged date: <!-- PR_DATE: {TODAY} -->.
+Avoid being repetitive and focus on the most important changes and their impact, discard any mention of version bumps/updates, changeset files, environment variables or syntax updates.
+PR Information:"""
+
+# Write the prompt to GITHUB_OUTPUT
+with open(GITHUB_OUTPUT, "a") as outputs_file:
+    outputs_file.write(f"BASE_PROMPT<<EOF\n{BASE_PROMPT}\nEOF")