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

Fast-forward cookiecutter #407

Merged
merged 15 commits into from
May 23, 2024
Merged

Fast-forward cookiecutter #407

merged 15 commits into from
May 23, 2024

Conversation

Zeitsperre
Copy link
Contributor

@Zeitsperre Zeitsperre commented May 17, 2024

Pull Request Checklist:

  • This PR addresses an already opened issue (for bug fixes / features)
    • This PR fixes #xyz
  • (If applicable) Documentation has been added / updated (for bug fixes / features).
  • (If applicable) Tests have been added.
  • This PR does not seem to break the templates.
  • CHANGES.rst has been updated (with summary of main changes).
    • Link to issue (:issue:number) and pull request (:pull:number) has been added.

What kind of change does this PR introduce?

  • Updates the template to the latest commit
  • GitHub Workflows now point to commits rather than tags
  • Dependabot will now only update on a monthly schedule
  • Dependencies have been updated and synchronized
  • CODE_OF_CONDUCT.rst file adapted to Contributor Covenant v2.1

Does this PR introduce a breaking change?

Yes.

  • CHANGES.rst is now CHANGELOG.rst
  • The package now uses a src layout in lieu of a flat layout
  • Maintainer-specific directions are now found under releasing.rst

Warning

The changes to the package structure requires you to fully reinstall the library using pip install -e .
This is almost like installing a brand new library, except it's virtually the same.

Other information:

https://packaging.python.org/en/latest/discussions/src-layout-vs-flat-layout/
https://keepachangelog.com/en/1.0.0/

@Zeitsperre Zeitsperre requested a review from RondeauG May 17, 2024 21:47
Copy link
Contributor

@RondeauG RondeauG left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

CHANGELOG.rst Outdated Show resolved Hide resolved
CODE_OF_CONDUCT.md Outdated Show resolved Hide resolved
Co-authored-by: Pascal Bourgault <bourgault.pascal@ouranos.ca>
@Zeitsperre Zeitsperre merged commit c676856 into main May 23, 2024
17 checks passed
@Zeitsperre Zeitsperre deleted the cookiecutter-update branch May 23, 2024 21:22
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

Successfully merging this pull request may close these issues.

None yet

3 participants