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

CHANGELOG.* not picked up by @dependabot #35

Closed
michaelbrewer opened this issue May 17, 2020 · 5 comments
Closed

CHANGELOG.* not picked up by @dependabot #35

michaelbrewer opened this issue May 17, 2020 · 5 comments
Assignees

Comments

@michaelbrewer
Copy link
Contributor

michaelbrewer commented May 17, 2020

Although there is a CHANGELOG.* in the project it is not being picked up by https://github.com/dependabot

It might either be that it is not in the base of the project (currently it is in a sub folder "python") or that is does not include an anchor tag at the release tag.

Otherwise adding maybe doing a git tag on release and creating github releases works without a CHANGELOG., but it is nice have the CHANGELOG. in the project itself.

@heitorlessa
Copy link
Contributor

heitorlessa commented May 17, 2020 via email

@michaelbrewer
Copy link
Contributor Author

The AWS CDK is a monorepo but has only a single CHANGELOG.md at the base of the project, but of coz they do keep releases for all of the subprojects in sync. You might not want to do this when you have a Typescript implementation? Or maybe that would just be a new repo?

@heitorlessa
Copy link
Contributor

heitorlessa commented May 17, 2020 via email

@heitorlessa
Copy link
Contributor

@michaelbrewer please feel free to reopen if having CHANGELOG in the root doesn't solve either

@michaelbrewer
Copy link
Contributor Author

Sure thing, best of luck.

I see that tools like Standard Version is quite popular, by using a conventional commit format to help generate Changelogs and version numbers. You can even setup pre-commit hooks to formalize it. The maintainers of AWS CDK do a great job.

heitorlessa added a commit that referenced this issue May 27, 2020
* develop:
  feat: add documentation website (#37)
  improv: move away from monorepo due to change in direction (#36)
  fix: #35 duplicate changelog to project root
heitorlessa referenced this issue in heitorlessa/aws-lambda-powertools-python Jun 17, 2020
Dependabot reads project's Changelog to inform what's changed in a dependency
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