Misformatted changelog on "Update Changelog" PR

Open
#907 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Start with the malformed changelog entry in commit 8afdd1a531e9cbf7f70beba8c734876b5b2df58f and inspect the collect_changes script at templates/github/.ci/scripts/collect_changes.py.j2. Trace how the title is produced and confirm the generated title no longer breaks the changelog ToC page.

Written by the indexing model from the issue text.

Description

bug

A recent "Update Changelog" PR on pulpcore added a malformed title which broke the changelog ToC page.
See here: https://github.com/pulp/pulpcore/commit/8afdd1a531e9cbf7f70beba8c734876b5b2df58f#r145350978

I didn't look into it yet, but maybe it's something that needs adjusting in the collect_changes script.

Screenshot

image

Dominant language
Python
Stars
10
Forks
40
Avg merge
21h 24m
Merged PRs (30d)
8

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.

More from pulp/plugin_template

All issues in pulp/plugin_template

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.