search

materialsproject / pymatgen

Python Materials Genomics (pymatgen) is a robust materials analysis code that defines classes for structures and molecules with support for many electronic structure codes. It powers the Materials Project.
https://pymatgen.org
Other
1.46k stars 847 forks source link

`invoke update-changelog` broken #2794

Closed janosh closed 1 year ago

janosh commented 1 year ago

@shyuep I was asked to make a new release. No objections from you?

Problem is invoke update-changelog recently started adding a bunch of rST incompatible markdown and HTML into CHANGES.rst. Example:

* PR #2757 from @materialsproject dependabot/pip/phonopy-2.16.3
    Bumps [phonopy](https://phonopy.github.io/phonopy/) from 2.4.2 to 2.16.3.
    [![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=phonopy&package-manager=pip&previous-version=2.4.2&new-version=2.16.3)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)
    Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`.
    [//]: # (dependabot-automerge-start)
    [//]: # (dependabot-automerge-end)
    ---
    <details>
    <summary>Dependabot commands and options</summary>
    <br />
    You can trigger Dependabot actions by commenting on this PR:
    - `@dependabot rebase` will rebase this PR
    - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
    - `@dependabot merge` will merge this PR after your CI passes on it
    - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
    - `@dependabot cancel merge` will cancel a previously requested merge and block automerging
    - `@dependabot reopen` will reopen this PR if it is closed
    - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
    - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
    - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
    - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
    </details>

Looks like this stems from re-activating dependabot in #2742 as per your request. What's your preference for fixing? We could either convert CHANGES.rst to markdown or modify update_changelog().

https://github.com/materialsproject/pymatgen/blob/c1a7f5d7635f85e7bc490658d52b70867ed24614/tasks.py#L250-L291

shyuep commented 1 year ago

You can delete the dependabot related change log. We don't need to put those in the changelog at all.

janosh commented 1 year ago

I wouldn't want them in there either but there are a dozen of them so don't feel like hand-curating the log. I'll tweak update_changelog() then.