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

Migrate to repo-config #88

Merged
merged 16 commits into from
Aug 9, 2023
Merged

Migrate to repo-config #88

merged 16 commits into from
Aug 9, 2023

Conversation

llucax
Copy link
Contributor

@llucax llucax commented Aug 8, 2023

Some of the changes were made in separate commits, but at some point a lot of changes had to be grouped together because they are just too interdependant.

  • Fix Python header

  • Update license formatting

  • Include hidden files in patterns by default

  • Move security warning

  • Update URL to avoid ambiguity

  • Improve labeler configuration

  • Remove unused labels from keylabeler

  • Improve wording in release notes and template

  • Fix typo in release notes and template

  • Reformat the feature issue template

  • Update bug issue template

  • Add cookiecutter replay file to easy upgrading the repo-config templates.

  • Migrate from tox to nox.

  • Move development dependencies to optional dependencies in the pyproject.toml file.

  • Add many other commmon configuration to the pyproject.toml file.

  • Make formatting of markdown files consistent with other projects.

  • Improve contributing guide with the dev dependencies improvements and to describe how to use nox and the docs generation.

  • Add badges and improve the readme.

  • Add mkdocs documentation pages and generation.

  • Improve the CI to match the template, this includes:

    • Using a new action for protolint that will add inline comments in the PR diffs.
    • Add support for merge queues.
    • Use nox.
    • Use the dev dependencies defined in the pyproject.toml file.
    • Add and improve names of steps and jobs.
    • Add jobs for testing and publishing the generated documentation.
    • Remove the creation of a discussion for each release.
  • Use from x import y instead of import x.y as y

  • Disable import outside toplevel pylint check

  • Add missing comments to test functions

The version is converted to an input because otherwise we need to create
labels and update the template for each major release, and this field
is barely used.

The rest are formatting and spelling/grammar fixes/improvements.

Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
We want to make sure the URL points to the repo.

Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
@llucax llucax requested review from a team as code owners August 8, 2023 14:43
@github-actions github-actions bot added part:docs Affects the documentation part:tests Affects the unit, integration and performance (benchmarks) tests part:tooling Affects the development tooling (CI, deployment, dependency management, etc.) part:python Affects the Python bindings labels Aug 8, 2023
@llucax llucax self-assigned this Aug 8, 2023
@llucax llucax added this to the v0.15.2 milestone Aug 8, 2023
@llucax
Copy link
Contributor Author

llucax commented Aug 8, 2023

OK, this worked locally but it is failing in the CI, I need to see what's happening but tomorrow :)

@llucax
Copy link
Contributor Author

llucax commented Aug 8, 2023

I think the bump of the dependency should fix it.

@llucax llucax enabled auto-merge August 8, 2023 14:50
@llucax
Copy link
Contributor Author

llucax commented Aug 8, 2023

Enabling auto-merge.

This includes a lot of changes that are very related to one another:

* Add cookiecutter replay file to easy upgrading the repo-config
  templates.

* Migrate from `tox` to `nox`.

* Move development dependencies to optional dependencies in the
  `pyproject.toml` file.

* Add many other commmon configuration to the `pyproject.toml` file.

* Make formatting of markdown files consistent with other projects.

* Improve contributing guide with the dev dependencies improvements and
  to describe how to use `nox` and the docs generation.

* Add badges and improve the readme.

* Add mkdocs documentation pages and generation.

* Improve the CI to match the template, this includes:

  * Using a new action for protolint that will add inline comments in
    the PR diffs.
  * Add support for merge queues.
  * Use `nox`.
  * Use the dev dependencies defined in the `pyproject.toml` file.
  * Add and improve names of steps and jobs.
  * Add jobs for testing and publishing the generated documentation.
  * Remove the creation of a discussion for each release.

Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
Now tests are checked for documentation.

Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
Now that pylint runs for tests we want to ignore this check in tests,
as we want to check for the imports themselves.

Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
Also there is a pylint check for this, as the later format is redundant.

Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
This is needed to be compatible with repo-config v0.4.0.

Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
Copy link
Contributor

@tiyash-basu-frequenz tiyash-basu-frequenz left a comment

Choose a reason for hiding this comment

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

A minor comment, but LGTM overall.

.cookiecutter-replay.json Show resolved Hide resolved
@llucax
Copy link
Contributor Author

llucax commented Aug 9, 2023

OK, tests are passing now. I will need to update the branch protection rules to use the new check names, other PRs will need to be rebased.

@llucax
Copy link
Contributor Author

llucax commented Aug 9, 2023

Updated rules and enabled the merge queue for v0.x.x.

@llucax llucax merged commit c33efab into frequenz-floss:v0.x.x Aug 9, 2023
9 checks passed
@llucax llucax deleted the repo-config branch August 9, 2023 07:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
part:docs Affects the documentation part:python Affects the Python bindings part:tests Affects the unit, integration and performance (benchmarks) tests part:tooling Affects the development tooling (CI, deployment, dependency management, etc.)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants