Copilot commented on code in PR #154: URL: https://github.com/apache/solr-orbit/pull/154#discussion_r4503862669
########## .agents/skills/changelog-fragment/SKILL.md: ########## @@ -0,0 +1,40 @@ +--- +name: changelog-fragment +description: Draft the changelog fragment (changelog.d/<PR>.<type>.md) for the changes on the current branch. Use when a PR is ready and has no fragment yet, or when a reviewer asks for one. +--- + +# Changelog fragment + +Format, types and attribution rules are in `changelog.d/README.md`; read it first. + +## Steps + +1. Find the `apache/solr-orbit` remote with `git remote -v`; it is often `upstream`, not + `origin`. Fetch it. Without such a remote, use the PR's base from + `gh pr view --json baseRefName` or ask. +2. Read `git log <remote>/main..HEAD --oneline` and the diff of the files that change + behaviour. Skip tests and CI unless they are the whole change. +3. If the change is not user-visible (refactoring, tests, CI), say so and stop. +4. Pick the type. Anything that makes users adapt a workload, flag or config file is + `breaking`, however small. +5. PR number: `gh pr view --json number -q .number`. Without a PR, use `+<slug>.<type>.md` + and tell the author to rename it. +6. Write one or two sentences for a user, naming the command, flag or feature they would + recognise, in backticks. +7. Append the author: `(@login)` from `gh pr view --json author -q .author.login` unless the + author prefers a nick or full name. +8. Show the rendered line from `make changelog-draft`. + +## Examples + +`changelog.d/124.fixed.md` + +```markdown +`solr-orbit stop` works again; it failed with a missing `metrics_store_class` attribute. (@jdoe) +``` + +`changelog.d/115.changed.md` + +```markdown +The `optimize` operation follows Solr's merge policy by default instead of forcing a single segment. Pass `max-num-segments` to restore the old behaviour. (@jdoe) Review Comment: The suggested `max-num-segments` parameter is silently ignored by `SolrOptimize`, which only reads `max-segments` (`solrorbit/worker_coordinator/runner.py:1356`). Following this example therefore leaves the merge-policy default in place instead of restoring a single segment. Use `max-segments` with an explicit value of `1`. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
