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 config option to disable Changelog #874

Closed
KennethEnevoldsen opened this issue Mar 26, 2024 · 4 comments
Closed

Add config option to disable Changelog #874

KennethEnevoldsen opened this issue Mar 26, 2024 · 4 comments
Labels
feature A new feature or a feature request

Comments

@KennethEnevoldsen
Copy link

Description

I would like to be able to not have a CHANGELOG.md file. This could e.g. be done by setting the Changelog to "" or creating a custom flag.

Use cases

Some repositories only want the version management of semver without the auto updated changelog.

Possible implementation

This could e.g. be done by setting the Changelog to "" or creating a custom flag. I believe it is already possible using:

[tool.semantic_release.changelog]
# no changelog:
changelog_file = "/dev/null"

which is OS specific.

@KennethEnevoldsen KennethEnevoldsen added the feature A new feature or a feature request label Mar 26, 2024
@codejedi365
Copy link
Contributor

Currently you can just provide the --no-changelog option on the command line for this. We do not have it as a configuration entry at this time.

@KennethEnevoldsen
Copy link
Author

But can I also use that option within the GitHub actions?

@codejedi365
Copy link
Contributor

codejedi365 commented Mar 26, 2024

But can I also use that option within the GitHub actions?

Docs: https://python-semantic-release.readthedocs.io/en/latest/github-action.html#command-line-options

Did you try:

- name: Python Semantic Release
  uses: python-semantic-release/python-semantic-release@v9.3.1
  with:
    changelog: "false"

@codejedi365
Copy link
Contributor

Closing as user has a working result for GitHub Actions and initial request lines up as part of #917

@codejedi365 codejedi365 removed the confirmed Prevent from becoming stale label May 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature A new feature or a feature request
Projects
None yet
Development

No branches or pull requests

2 participants