Skip to content

Conversation

@dependabot
Copy link

@dependabot dependabot bot commented on behalf of github Dec 28, 2023

Bumps frequenz-repo-config[lib] from 0.4.0 to 0.8.0.

Release notes

Sourced from frequenz-repo-config[lib]'s releases.

v0.8.0

Frequenz Repository Configuration Release Notes

Summary

This is a minor release with some documentation improvements, new GitHub ruleset and a few bug fixes.

Upgrading

Cookiecutter template

You can follow these steps to upgrade without regenerating the whole project, if you kept the default project structure and configuration:

  • Update the frequenz-repo-config dependencies in pyproject.toml to 0.8.0.

  • Run in the root directory of your project:

    sed -i '/custom_templates: templates/d' mkdocs.yml
    sed -i '/  "too-few-public-methods",/a \  "too-many-return-statements",' pyproject.toml
    find -type f -exec sed -i 's/Freqenz/Frequenz/g' {} +
    cat <<EOF >> .gitignore
    Auto-generated python files from the protocol buffer compiler
    py//*_pb2.py
    py//_pb2.pyi
    py/**/_pb2_grpc.py
    py/**/*_pb2_grpc.pyi
    EOF

  • Optionally go to the GitHub project's settings and replace branch protection rules with the new rulesets. See the new GitHub configuration guide for more details.

New Features

  • New GitHub rulesets are provided with the recommended configuration to protect branches and tags.
  • The documentation is restructured into a more organized, easier-to-navigate user guide.
  • Documentation on how to configure the GitHub project and PyPI package is now provided.

Cookiecutter template

  • The pylint check too-many-return-statements is now disabled by default.
  • Generated protobuf files are now ignored by Git.

Bug Fixes

Cookiecutter template

  • Fix typo: Freqenz -> Frequenz
  • Fix mkdocs.yml to avoid specifying custom_templates for mkdocstrings as it is unused and is checked for existence in newer versions.

... (truncated)

Changelog

Sourced from frequenz-repo-config[lib]'s changelog.

Frequenz Repository Configuration Release Notes

Summary

This is a minor release with some documentation improvements, new GitHub ruleset and a few bug fixes.

Upgrading

Cookiecutter template

You can follow these steps to upgrade without regenerating the whole project, if you kept the default project structure and configuration:

  • Update the frequenz-repo-config dependencies in pyproject.toml to 0.8.0.

  • Run in the root directory of your project:

    sed -i '/custom_templates: templates/d' mkdocs.yml
    sed -i '/  "too-few-public-methods",/a \  "too-many-return-statements",' pyproject.toml
    find -type f -exec sed -i 's/Freqenz/Frequenz/g' {} +
    cat <<EOF >> .gitignore
    Auto-generated python files from the protocol buffer compiler
    py//*_pb2.py
    py//_pb2.pyi
    py/**/_pb2_grpc.py
    py/**/*_pb2_grpc.pyi
    EOF

  • Optionally go to the GitHub project's settings and replace branch protection rules with the new rulesets. See the new GitHub configuration guide for more details.

New Features

  • New GitHub rulesets are provided with the recommended configuration to protect branches and tags.
  • The documentation is restructured into a more organized, easier-to-navigate user guide.
  • Documentation on how to configure the GitHub project and PyPI package is now provided.

Cookiecutter template

  • The pylint check too-many-return-statements is now disabled by default.
  • Generated protobuf files are now ignored by Git.

Bug Fixes

Cookiecutter template

  • Fix typo: Freqenz -> Frequenz
  • Fix mkdocs.yml to avoid specifying custom_templates for mkdocstrings as it is unused and is checked for existence in newer versions.
  • Fix paths that are not translated properly from the python package name (#198)

... (truncated)

Commits
  • c82454d Add section on configuring PyPI to the user guide (#205)
  • 56e4ed3 Update release notes
  • dbc6601 Add section about configuring PyPi to the user guide
  • a2ff3d2 Rename markdown file to match the page title
  • 560463d Make page title consistent with the others
  • 711ac38 Prepare for v0.8.0 release (#204)
  • e602cac Prepare for v0.8.0 release
  • aedc357 docs: Improve gh-pages initialization (#203)
  • b638e66 Ignore files generated from proto files (#202)
  • 6f34b76 Properly translate paths from the python package name (#199)
  • Additional commits viewable in compare view

Dependabot compatibility score

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot merge will merge this PR after your CI passes on it
  • @dependabot squash and merge will squash and merge this PR after your CI passes on it
  • @dependabot cancel merge will cancel a previously requested merge and block automerging
  • @dependabot reopen will reopen this PR if it is closed
  • @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
  • @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
  • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

Bumps [frequenz-repo-config[lib]](https://github.com/frequenz-floss/frequenz-repo-config-python) from 0.4.0 to 0.8.0.
- [Release notes](https://github.com/frequenz-floss/frequenz-repo-config-python/releases)
- [Changelog](https://github.com/frequenz-floss/frequenz-repo-config-python/blob/v0.x.x/RELEASE_NOTES.md)
- [Commits](frequenz-floss/frequenz-repo-config-python@v0.4.0...v0.8.0)

---
updated-dependencies:
- dependency-name: frequenz-repo-config[lib]
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot dependabot bot added part:tooling part:tooling Affects the development tooling (CI, deployment, dependency management, etc.) type:tech-debt Improves the project without visible changes for users labels Dec 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

part:tooling part:tooling Affects the development tooling (CI, deployment, dependency management, etc.) type:tech-debt Improves the project without visible changes for users

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant