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

Please accept CHANGELOG.md name #2116

Open
fedelibre opened this issue Jan 17, 2025 · 1 comment
Open

Please accept CHANGELOG.md name #2116

fedelibre opened this issue Jan 17, 2025 · 1 comment
Labels
enhancement New features, or improvements to existing features. good first issue Is this your first time contributing? This could be a good place to start! linux The issue relates Linux support.

Comments

@fedelibre
Copy link

Describe the bug

Please accept CHANGELOG.md name.
The .md extensions allows a nice rendering on GitHub and similar websites.

It is also a recommended name in keepachangelog.com spec.

Steps to reproduce

On Linux run briefcase build in a project which has CHANGELOG.md (instead of CHANGELOG) in the project root directory.
You'll get the following error:

Installing license... done
Installing changelog... errored

Your project does not contain a CHANGELOG file.

Create a file named `CHANGELOG` in the same directory as your `pyproject.toml`
with details about the release.

and the build will stop.

Expected behavior

The build should find CHANGELOG.md and complete successfully.

My current workaround is copying/symlinking the expected name, but I'd rather avoid it.

Thanks for considering this.

Screenshots

No response

Environment

  • Operating System: Linux (Fedora 41)
  • Python version: 3.13.1
  • Software versions:
    • Briefcase: 0.3.20

Logs

No response

Additional context

No response

@fedelibre fedelibre added the bug A crash or error in behavior. label Jan 17, 2025
@freakboy3742 freakboy3742 added good first issue Is this your first time contributing? This could be a good place to start! linux The issue relates Linux support. enhancement New features, or improvements to existing features. and removed bug A crash or error in behavior. labels Jan 18, 2025
@freakboy3742
Copy link
Member

The Changelog is used for both the RPM and PKG.ZIP formats; in the RPM case, the file just needs to be available for reading; for PKG.ZIP, the file is copied, but the filename can be configured. Since there's no hard-requirement for a file named CHANGELOG, it would make sense to support as many possible candidate filenames for changelog data.

The keepachangelog.com README also suggests HISTORY, NEWS and RELEASES as possible names; it would make sense to me support all those options, in .md, .rst, .txt and "bare no-extension" formats, and whichever one is found first get used.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New features, or improvements to existing features. good first issue Is this your first time contributing? This could be a good place to start! linux The issue relates Linux support.
Projects
None yet
Development

No branches or pull requests

2 participants