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.

Sign up for GitHub

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

Jump to bottom

Update to repo-config v0.7.2 #230

Merged
merged 1 commit into from
Nov 1, 2023
Merged

Update to repo-config v0.7.2 #230

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/containers/nox-cross-arch/arm64-ubuntu-20.04-python-3.11.Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# License: MIT
# Copyright © 2023 Frequenz Energy-as-a-Service GmbH
# This Dockerfile is used to run the tests in architectures not supported by
# GitHub Actions.
# This Dockerfile is used to run the tests in arm64, which is not supported by
# GitHub Actions at the moment.

FROM docker.io/library/ubuntu:20.04

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/ci.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -363,7 +363,7 @@ jobs:
if: steps.mike-version.outputs.version
run: |
git checkout gh-pages
python -m frequenz.repo.config.cli.version.mkdocs.sort versions.json
python -m frequenz.repo.config.cli.version.mike.sort versions.json
Copy link
Contributor

Choose a reason for hiding this comment

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

I would not have spotted that! I mean, what's mike?

Copy link
Contributor Author

@llucax llucax Nov 1, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

https://github.com/frequenz-floss/frequenz-repo-config-python/blob/v0.x.x/CONTRIBUTING.md#building-the-documentation

or https://github.com/jimporter/mike

Copy link
Contributor

Choose a reason for hiding this comment

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

thx

git commit -a -m "Sort versions.json"

- name: Publish site
Expand Down
8 changes: 4 additions & 4 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
requires = [
"setuptools == 68.1.0",
"setuptools_scm[toml] == 7.1.0",
"frequenz-repo-config[lib] == 0.7.1",
"frequenz-repo-config[lib] == 0.7.2",
]
build-backend = "setuptools.build_meta"

Expand Down Expand Up @@ -53,15 +53,15 @@ dev-mkdocs = [
"mkdocs-material == 9.3.2",
"mkdocs-macros-plugin == 1.0.4",
"mkdocstrings[python] == 0.23.0",
"frequenz-repo-config[lib] == 0.7.1",
"frequenz-repo-config[lib] == 0.7.2",
]
dev-mypy = [
"mypy == 1.6.1",
"types-Markdown == 3.4.2.10",
# For checking the noxfile, docs/ script, and tests
"frequenz-channels[dev-mkdocs,dev-noxfile,dev-pytest]",
]
dev-noxfile = ["nox == 2023.4.22", "frequenz-repo-config[lib] == 0.7.1"]
dev-noxfile = ["nox == 2023.4.22", "frequenz-repo-config[lib] == 0.7.2"]
dev-pylint = [
"pylint == 2.17.7",
# For checking the noxfile, docs/ script, and tests
Expand All @@ -71,7 +71,7 @@ dev-pytest = [
"pytest == 7.4.3",
"async-solipsism == 0.5",
"hypothesis == 6.88.1",
"frequenz-repo-config[extra-lint-examples] == 0.7.1",
"frequenz-repo-config[extra-lint-examples] == 0.7.2",
Copy link
Contributor

Choose a reason for hiding this comment

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

What generally bugs me (and that's not only a Python-only problem), is that you need to update the version in so many places, all at once, that it's not too hard to accidentally miss one, when you want to bump it. But I guess there's no better way of doing it, or is there?

What I imagine in my head is some kind of single source of truth, and if dev-pylint as well as dev-noxfile both need frequenz-repo-config at version X, then they $var that version from that single source. This would make upgrading at least way less error-prone. (I'm just thinking out loud here) :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Not that I know of, we can greatly simplify this by having only one dev optional dependencies that just install everything, that's in the roadmap for repo-config, I think having this level of fine grain have very little advantages and a lot of issues. But we'll still need to put it twice (one in build deps and one in dev deps).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The other issue is repo-config now holds both a library and the cookiecutter templates. Actually all these point releases are for the cookiecutter templates only, so there is no difference if we didn't upgrade the dependency here. Once we split the templates to a different repo, this should also become better.

Then we might even want to split repo-config in the build part of it and the dev part of it, so then both dependencies would be independent and we'll only need to update one when it really changes (but I see this as a second stage change).

Finally, once it is more stable, dependabot should be able to update repo-config automatically too.

But yeah, a lot could be done to improve the situation but it requires a lot of work.

"pytest-asyncio == 0.21.1",
"pytest-mock == 3.12.0",
]
Expand Down