Update cookiecutter to new standard via cruft #319
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Zeitsperre
added
documentation
Zeitsperre
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request Checklist:
number) and pull request (:pull:number) has been added.What kind of change does this PR introduce?
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.ymlhas been replaced withDependabot(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.Dependabotshould do this task automatically via Pull Requests.Versioning scheme is now SemVer 2.0-compliant:
-devor-dev.##,$ bump-my-version bump patchwill be called. This will set the version atX.Y.Z+1-dev. Otherwise,$ bump-my-version bump buildwill be called. This is all automated by thebump-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.0→1.2.1) or$ bump-my-version bump minorthen$ bump-my-version bump release(for a minor release; i.e.1.2.0→1.3.0)There is now also support for Documentation locales (translations) via
.pofiles. These can be staged with$ make initialize-translations, whereby.pofiles will be generated and French (or other) language strings can be added.* I'm not sure how this will interact with existing translation code. Might be worth it to leave this deactivated
Other information:
Ouranosinc/cookiecutter-pypackage#30