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

Update cookiecutter template via cruft #143

Merged
merged 10 commits into from
Jan 31, 2024
Merged

Update cookiecutter template via cruft #143

merged 10 commits into from
Jan 31, 2024

Conversation

Zeitsperre
Copy link
Contributor

@Zeitsperre Zeitsperre commented Jan 29, 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.
  • 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 cookiecutter with the newest conventions and workflows

Does this PR introduce a breaking change?

Boilerplate documentation is largely unchanged. Workflows are now more a bit more elegant, including automatic labelling, warnings about unsafe changes to workflows, security-related changes, etc.

actions-versions-updater.yml has been replaced with Dependendabot (it's just better).

There's support for evaluating the OpenSSF Scorecard (this can be disabled if we want).

Code formatting tools are now hard-pinned. These need to be kept in sync with changes from pre-commit. Dependabot should do this task automatically via Pull Requests.

Versioning scheme is now SemVer 2.0-compliant:

  • If the version doesn't end in -dev or -dev.##, $ bump-my-version bump patch will be called. This will set the version at X.Y.Z+1-dev. Otherwise, $ bump-my-version bump build will be called. This is all automated by the bump-version.yml.

When the version is ready for a release, it's up to the maintainer to call the following:

  • $ bump-my-version bump release (for a patch release; i.e. 1.2.01.2.1) or
  • $ bump-my-version bump minor then $ bump-my-version bump release (for a minor release; i.e. 1.2.01.3.0)

There is now also support for Documentation locales (translations) via .po files. These can be staged with $ make initialize-translations, whereby .po files will be generated and French (or other) language strings can be added.

Other information:

Ouranosinc/cookiecutter-pypackage#30

@Zeitsperre Zeitsperre added documentation Improvements or additions to documentation dependencies Pull requests that update a dependency file labels Jan 29, 2024
@Zeitsperre Zeitsperre self-assigned this Jan 29, 2024
Copy link
Collaborator

@sarahclaude sarahclaude left a comment

Choose a reason for hiding this comment

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

Merci Trevor!

@Zeitsperre Zeitsperre merged commit 3ee9a0e into main Jan 31, 2024
16 checks passed
@Zeitsperre Zeitsperre deleted the cookiecutter-update branch January 31, 2024 16:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants