cloudflare / cloudflare/telescope

Improve and document release / changelog process

Open
#320 0 comments 0 reactions 0 assignees View on GitHub
project-maintenance
Dominant language
TypeScript
Stars
305
Forks
36
PR merge metrics
No merged PRs in 30d

Description

We use `changesets` package to automate our release workflow and generate changelog automatically.

Commands to run are documented in .changesets/README.md

It is used in `telescope` and `waterfall` packages both of which are published to NPM and can be used in `telescope-web` when we are going to start publishing it to npm.

We have a few options:
1. disable automated attribution in config.json using `disableThanks: true` and manually add attribution
2. write [our own formatter](https://github.com/changesets/changesets/blob/main/docs/modifying-changelog-format.md) that is smarter than default @changesets/changelog-github which checks [commit author](https://github.com/changesets/changesets/blob/main/packages/get-github-info/src/get-pull-request-info.ts#L45-L51) only
3. configure @changesets/changelog-github to use co-contributors or other additional PR tags on the commit as authors instead of a person doing the comiting. It is either already supported and it is not as dumb as it looks, or we need to contribute this support

Contributor guide

Open the contributing guide

Research direction

Read .changesets/README.md and config.json, then compare the release setup used by the telescope and waterfall packages. Review the linked Changesets formatter and GitHub-info documentation to choose an attribution approach; done means one agreed process is implemented and documented for the listed packages.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, release
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.