Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add changelog #55

Open
line-o opened this issue Aug 29, 2022 · 2 comments
Open

add changelog #55

line-o opened this issue Aug 29, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@line-o
Copy link
Member

line-o commented Aug 29, 2022

The changelog should be created from the information gathered for the release notes.

The release automation should also generate / append the changelog with the (formatted) release notes from semantic-release (see https://github.com/semantic-release/changelog).

The file must be in a format that the public package repository supports so that it is visible on the roaster package information page

@line-o line-o added documentation Improvements or additions to documentation enhancement New feature or request labels Aug 29, 2022
@line-o
Copy link
Member Author

line-o commented Aug 29, 2022

Public repo does support adding them as XML into repo.xml.

  • Add changelog-element to repo.xml
  • for each released version there should be one change-element with a version-attribute
  • each change has an unordered list (in xhtml namespace)
    <changelog>
        <change version="5.0.2">
            <ul xmlns="http://www.w3.org/1999/xhtml">
                <li>Enhanced docx to TEI import</li>
                <li>Fix whitespace issues around pb-popover</li>
                <li>Fixed login issue if user belongs to multiple groups</li>
            </ul>
        </change>
    ...
   </changelog>

The plugin does produce a changelog.md by default. It is unclear if this file and format can be used directly. It would simplify the process a great deal if it did.

@line-o
Copy link
Member Author

line-o commented Aug 29, 2022

I just checked the current implementation of the public package repository. It can only read changelogs in repo.xml

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant