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

Improve invoke generate-release-notes to place the towncrier generated content in the appropriate file automatically #149

Open
cmsirbu opened this issue Aug 20, 2024 · 4 comments

Comments

@cmsirbu
Copy link
Contributor

cmsirbu commented Aug 20, 2024

As a repository maintainer, I would like to have a simpler release process, in this case taking the output of towncrier and placing it in the correct release notes file:

  • For patch releases, insert it at the right marker in the existing markdown file
  • For major/minor releases, generate the new release notes file from a template with the appropriate filename derived from the pyproject version first, then insert the release notes
@jifox
Copy link

jifox commented Feb 17, 2025

Hi, I needed to add environment = { DJANGO_SETTINGS_MODULE = "development.nautobot_config" } in pyproject.toml in section [tool.towncrier] else I got a traceback

@cmsirbu
Copy link
Contributor Author

cmsirbu commented Feb 18, 2025

Hi, I needed to add environment = { DJANGO_SETTINGS_MODULE = "development.nautobot_config" } in pyproject.toml in section [tool.towncrier] else I got a traceback

We used to have this actually, but with the steps outlined in the Release Checklist (in the Developer Guide section of the Docs) it was not needed anymore. How did you run towncrier to get a traceback?

@jifox
Copy link

jifox commented Feb 18, 2025

Hi Cristian, I have a docker nautobot-app installation and just executed the invoke generate-release-notes --version 1.4.2 command as the developer guide docs/dev/release_checklist.md is telling me. After adding the environment the error message about module "nautobot_config" could not be found is gone.

@cmsirbu
Copy link
Contributor Author

cmsirbu commented Feb 18, 2025

Hi Cristian, I have a docker nautobot-app installation and just executed the invoke generate-release-notes --version 1.4.2 command as the developer guide docs/dev/release_checklist.md is telling me. After adding the environment the error message about module "nautobot_config" could not be found is gone.

Hey Josef, it looks like you're on an older version of the tasks.py file. We've updated it with the release checklist, so it never needs to import the app anymore (the reason for the traceback that you're getting). It'll get the version either from the command line (recommended) or from poetry (that is defined in pyproject.toml) - see diff here: https://github.com/nautobot/cookiecutter-nautobot-app/pull/144/files#diff-d479618ef359402afcbe0919a72105abbc3a7519720311a83686d39b0d8cb89a

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants