scala / scala/make-release-notes

updating download/index.md should be automated

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

Nobody has claimed this yet.

enhancement
Dominant language
HTML
Stars
82
Forks
79
PR merge metrics
No merged PRs in 30d

Description

currently the script just says:

src/main/scala/MakeReleaseNotes.scala: println(s"# don't forget to\n${scala.util.Properties.envOrElse("EDITOR", "mate")} ../scala-lang/download/index.md ../scala-lang/documentation/api.md ../scala-lang/_config.yml")

but the manual changes you need to make to download/index.md are annoying

Contributor guide

No contributing guide indexed for this repository

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 in src/main/scala/MakeReleaseNotes.scala and inspect the current prompt alongside download/index.md. Identify which manual changes the release process requires and determine how the script should update that file automatically. Done means the release workflow no longer depends on manually editing download/index.md; no test file is mentioned in the issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
scala
Domain
release, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.