release-notes-prompt.py 1.1 KB

1234567891011121314151617
  1. import os
  2. from datetime import datetime;
  3. from pytz import timezone
  4. GITHUB_OUTPUT = os.getenv("GITHUB_OUTPUT")
  5. TODAY = datetime.now(timezone('US/Eastern')).isoformat(sep=' ', timespec='seconds')
  6. BASE_PROMPT = f"""Based on the following 'PR Information', please generate a concise and informative release notes to be read by developers.
  7. 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 sections for '🚀 New Features & Improvements', '🐛 Bugs Fixed' and '🔧 Other Updates', with heading level 3, skip respectively the sections if not applicable.
  8. Finally include the following markdown comment with the PR merged date: <!-- PR_DATE: {TODAY} -->.
  9. Avoid being repetitive and focus on the most important changes and their impact, don't mention version bumps, nor changeset files, nor environment variables, nor syntax updates.
  10. PR Information:"""
  11. # Write the prompt to GITHUB_OUTPUT
  12. with open(GITHUB_OUTPUT, "a") as outputs_file:
  13. outputs_file.write(f"BASE_PROMPT<<EOF\n{BASE_PROMPT}\nEOF")