-
Notifications
You must be signed in to change notification settings - Fork 236
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
Attribute changelog_file
not having an effect
#923
Comments
I'm sorry for the confusion you are experiencing. Initially, if you are using the custom template directory (and the directory exists) then the Additionally if you want it to be in the docs folder, make a docs folder in the template directory and place your changelog template into that directory. The folder structure will be transplanted into your project structure after stripping off the config defined template directory |
Ok, now everything makes sense. Thank you very much! :) |
Running
python-semantic-release==9.7.1
as a part of a Gitlab CI/CD pipeline always creates the changelog file namedCHANGELOG.md
in the root of the repository, no matter what I specify in thechangelog_file
attribute of thepyproject.toml
file.As described in the documentation, by using the
changelog_file
attribute in the[tool.semantic_release.changelog]
part of thepyproject.toml
configuration file, one is suppose to be able to specify a name for the changelog file to be created bypython-semantic-release
.My initial thought was to use this attribute to put the changelog file in a subdirectory. E. g.
changelog_file = "./docs/CHANGELOG.md"
.When this didn't work, out of curiosity I've tried to just change the name of the resulting changelog file and not the location. E.g.
changelog_file = "REALLY_COOL_CHANGELOG.md"
. Still, changelog file that is created is simply namedCHANGELOG.md
which is also the default value.I'm running
python-semantic-release
as a job in a GitLab CI/CD pipeline inside a Docker container based onDebian GNU/Linux 10 (buster)
.Same behavior happens regardless of using
poetry
orpip + requirements.txt
Configuration
Logs
Additionally, even though messages in the log above suggest that "No release will be made" the 0.3.0 release is indeed made as it should be in this demo case because previous version was 0.2.0 and
feat
commits were made in the meanwhile.A custom template for the changelog file is used and the changelog created by the python-semantic-release is indeed based on that custom template, however it is not named correctly.
Obviously I've changed a few details in the presented
pyproject.toml
and log output because we are usingpython-semantic-release
as a part of a private, company repository.Am I doing something wrong or is this a bug?
The text was updated successfully, but these errors were encountered: