wordpress-mobile / wordpress-mobile/release-toolkit

Do not add empty line to `RELEASE-NOTES.txt` if new section already exists

Open
#528 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Ruby
Stars
31
Forks
10
Avg merge
5h 45m
Merged PRs (30d)
2

Description

See https://github.com/woocommerce/woocommerce-android/pull/10359#discussion_r1422058546

We should avoid this kind of confusing diff

image

Even though, a question that's also interesting is how the RELEASE-NOTES.txt ended up with that header for the next version before the code freeze automation run in the first place.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing the release automation that updates RELEASE-NOTES.txt and reproduce the case where the next-version section already exists before the automation runs. Verify that the resulting release notes do not gain an extra empty line, and investigate when that header is created.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
release
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.