Updates for January 2024 #30
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
…yml configuration
…e hyperlinks better, formatting
Zeitsperre
added
documentation
RondeauG
approved these changes
Jan 25, 2024
This was referenced Jan 29, 2024
Zeitsperre
added a commit
to Ouranosinc/xscen
that referenced
this pull request
Feb 1, 2024
### 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 `Dependabot` (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.0` → `1.2.1`) or * `$ bump-my-version bump minor` then `$ 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 `.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. * **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
Zeitsperre
added a commit
to hydrologie/xhydro
that referenced
this pull request
Feb 1, 2024
### What kind of change does this PR introduce? * Updates the cookiecutter to the latest commits * `xhydro` is now Semantic Version v2.0.0-compliant * Added a few workflows (Change file labelling, Cache cleaning, Dependency scans, OpenSSF Scorecard) * Updated pre-commit hook versions * Formatting tools are now pinned to their pre-commit equivalents * `actions-version-updater.yml` has been replaced by `dependabot` ### 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.0` → `1.2.1`) or * `$ bump-my-version bump minor` then `$ bump-my-version bump release` (for a minor release; i.e. `1.2.0` → `1.3.0`) ### Other information: Ouranosinc/cookiecutter-pypackage#30
5 tasks
Zeitsperre
added a commit
to hydrologie/xdatasets
that referenced
this pull request
Feb 2, 2024
### What kind of change does this PR introduce? * Updates the cookiecutter to the latest commits * `xdatasets` is now Semantic Version v2.0.0-compliant * Added a few workflows (Change file labelling, Cache cleaning, Dependency scans, OpenSSF Scorecard) * Updated pre-commit hook versions * Formatting tools are now pinned to their pre-commit equivalents * `actions-version-updater.yml` has been replaced by `dependabot` ### 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.0` → `1.2.1`) or * `$ bump-my-version bump minor` then `$ bump-my-version bump release` (for a minor release; i.e. `1.2.0` → `1.3.0`) ### Other information: Ouranosinc/cookiecutter-pypackage#30
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.
Changes
bump-my-versionto use a SemVer-v2.0-compliant versioning scheme.READMEfile to explain some of the post-install processes required. More documentation is probably necessary.README's for easier updating and clarity.actions-version-updater.yml).workflow-warning.yml) for emitting warnings for reviewers when an external service/user updates workflow files.pre-commithook versions.Python3.12is supported.