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

Upgrade to repo-config v0.5.2 #153

Merged
merged 13 commits into from
Sep 11, 2023
Merged

Conversation

llucax
Copy link
Contributor

@llucax llucax commented Aug 17, 2023

All the changes are related to regenerating the files using the cookiecutter templates in repo-config v0.5.2.

  • Remove extensions from replay file
  • Add empty Introduction variable
  • Bump repo-config version to v0.5.2.
  • Add common pylint options
  • Add common source paths for isort
  • Add editorconfig file
  • Use repo-config for linting examples in docstrings
  • ci: Checkout submodules
  • Add a workflow to make sure release notes are updated
  • Don't ship development files in the source distribution
  • Add and sort mkdocs markdown extensions
  • mkdocs: Add comment with more info about cross-linking
  • Bump setuptools version

@llucax llucax requested a review from a team as a code owner August 17, 2023 13:10
@llucax llucax requested a review from shsms August 17, 2023 13:10
@github-actions github-actions bot added the part:tooling Affects the development tooling (CI, deployment, dependency management, etc.) label Aug 17, 2023
@llucax llucax added type:tech-debt Improves the project without visible changes for users cmd:skip-release-notes It is not necessary to update release notes for this PR labels Aug 17, 2023
@llucax llucax changed the title Upgrade to repo-config v0.5.1 Upgrade to repo-config v0.5.2 Aug 18, 2023
@llucax llucax added this to the v0.17.0 milestone Aug 18, 2023
@llucax llucax self-assigned this Aug 18, 2023
@llucax llucax enabled auto-merge August 18, 2023 07:26
@@ -79,6 +76,8 @@ markdown_extensions:
- name: mermaid
class: mermaid
format: "!!python/name:pymdownx.superfences.fence_code_format"
- pymdownx.tabbed
- pymdownx.tasklist
Copy link
Contributor

Choose a reason for hiding this comment

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

it seems pymdownx.superfences was removed in the commit Add and sort mkdocs markdown extensions. Was this deliberately done?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, it was duplicated. I clarified it in the commit.

Copy link
Contributor

@daniel-zullo-frequenz daniel-zullo-frequenz left a comment

Choose a reason for hiding this comment

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

I have only a question to check for and the PR needs rebasing to the latest v0.x.x

recursive-exclude tests *
recursive-exclude benchmarks *
Copy link
Contributor

Choose a reason for hiding this comment

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

We no longer exclude the benchmarks?

Copy link
Contributor Author

@llucax llucax Sep 11, 2023

Choose a reason for hiding this comment

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

Yes, from the source distribution package.

I misunderstood, you are right, this shouldn't be removed. Good catch!

Marenz
Marenz previously approved these changes Sep 7, 2023
We always want to use the template provided extensions, keeping our own
list only makes it more likely to have errors when upgrading.

Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
The new template use it to show some help about cookiecutter variables,
so we include it to avoid prompts when upgrading.

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>
This is to have a common basic configuration that should work with most
editors/IDEs.

Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
Now repo-config ships support to easily enable the collection and
linting of code examples in docstrings, so we use that instead.

Also make sure that we label the `conftest.py` file properly and we
exclude it from the source distribution.

Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
This is not really used in this project, but it is included as part of
the repo-config ci template, as it doesn't hurt either.

Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
When a PR is changing files in the `proto` or `py` directories, this
workflow will fail if the release notes weren't updated in the PR too,
unless the label `cmd:skip-release-notes` is set in the PR, which
signals that this PR doesn't need a release notes update.

Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
This also removes a duplicated entry for `pymdownx.superfences`.

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
Copy link
Contributor Author

llucax commented Sep 11, 2023

Rebased and fixed the wrong removal of the benchmarks exclusion.

@llucax
Copy link
Contributor Author

llucax commented Sep 11, 2023

It would be good to merge this soon (before merging other dependabot stuff) as I got a few conflicts when rebasing.

@llucax llucax added this pull request to the merge queue Sep 11, 2023
Merged via the queue into frequenz-floss:v0.x.x with commit b48d51b Sep 11, 2023
@llucax llucax deleted the repo-config-0.5 branch September 11, 2023 12:25
@llucax llucax modified the milestones: v1.0.0, v1.0.0-rc.1 Mar 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cmd:skip-release-notes It is not necessary to update release notes for this PR 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.

3 participants