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

Eliminate tedious release notes process for collections repos #11936

Closed
1 task done
zangell44 opened this issue Feb 8, 2024 · 1 comment
Closed
1 task done

Eliminate tedious release notes process for collections repos #11936

zangell44 opened this issue Feb 8, 2024 · 1 comment
Assignees
Labels
development Tech debt, refactors, CI, tests, and other related work.

Comments

@zangell44
Copy link
Collaborator

First check

  • I am a contributor to the Prefect codebase

Description

Currently our collections repos maintain a CHANGELOG that's updated on every PR and then manually updated for each release. There is no need for this process.

We should

  1. Get rid of CHANGELOG.md and any references to it (e.g. the PR checklist item)
  2. Update internal Notion doc with instructions to use GitHub's autogenerated release notes

Impact

Toil.

Additional context

No response

zzstoatzz added a commit to PrefectHQ/prefect-great-expectations that referenced this issue Feb 8, 2024
Remove changelog

This PR is a part of a series of automated changes that remove the
`CHANGELOG.md` file and update the PR template accordingly.

See PrefectHQ/prefect#11936
@zzstoatzz
Copy link
Collaborator

zzstoatzz commented Feb 8, 2024

completed via:

  • ./scripts/collections-manager clone
  • ./scripts/collections-manager branch "rm-changelog"
  • ./scripts/collections-manager run-function functions:thursday_feb_8_2024_update_pr_template
  • ./scripts/collections-manager commit "rm changelog and update PR template"
  • ./scripts/collections-manager pull-request
def thursday_feb_8_2024_update_pr_template(repo: Path) -> None:
    
    changelog_path = repo / "CHANGELOG.md"
    if changelog_path.exists():
        changelog_path.unlink()
    
    pr_template_path = repo / ".github" / "PULL_REQUEST_TEMPLATE.md"
    if pr_template_path.exists():
        with open(pr_template_path, "r") as file:
            lines = file.readlines()
        with open(pr_template_path, "w") as file:
            file.writelines(lines[:-1])

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
development Tech debt, refactors, CI, tests, and other related work.
Projects
None yet
Development

No branches or pull requests

2 participants