Migrate to repo-config (#88)

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.
  * Remove redundant `with: submodules: true`.
  * 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

Author: llucax

.cookiecutter-replay.json

@@ -0,0 +1,31 @@
+{
+  "cookiecutter": {
+    "Introduction": "]\n\nWelcome to repo-config Cookiecutter template!\n\nThis template will help you to create a new repository for your project. You will be asked to provide some information about your project.\n\nHere is an explanation of what each variable is for and will be used for:\n\n* `type`: The type of repository. It must be chosen from the list.\n\n* `name`: The name of the project. This will be used to build defaults for\n  other inputs, such as `title`, `python_package`, etc. It should be one word,\n  using only alphanumeric characters (and starting with a letter). It can\n  include also `_` and `-` which will be handled differently when building\n  other variables from it (replaced by spaces in titles for example).\n\n* `description`: A short description of the project. It will be used as the\n  description in the `README.md`, `pyproject.toml`, `mkdocs.yml`, etc.\n\n* `title`: A human-readable name or title for the project. It will be used in\n  the `README.md`, `CONTRIBUTING.md`, and other files to refer to the project,\n  as well as the site title in `mkdocs.yml`.\n\n* `keywords`: A comma-separated list of keywords that will be used in the\n  `pyproject.toml` file. If left untouched, it will use only some predefined\n  keywords. If anything else is entered, it will be **added** to the default\n  keywords.\n\n* `github_org`: The GitHub handle of the organization where the project will\n  reside. This will be used to generate links to the project on GitHub.\n\n* `license`: Currently, only two options are provided: `MIT`, which should be\n  used for open-source projects, and `Proprietary`, which should be used for\n  closed-source projects. This will be added to file headers and used as the\n  license in `pyproject.toml`.\n\n* `author_name`, `author_email`: The name and email address of the author of\n  the project. They will be used in the copyright notice in file headers and\n  as the author in `pyproject.toml`.\n\n* `python_package`: The Python package in which this project will reside. All\n  files provided by this project should be located in this package. This needs\n  to be a list of valid Python identifiers separated by dots. The source file\n  structure will be derived from this. For example, `frequenz.actor.example`\n  will generate files in `src/frequenz/actor/example`.\n\n* `pypi_package_name`: The name of the PyPI/wheel/distribution package. This\n  should be consistent with the `python_package`, usually replacing `.` with\n  `-`. For example, `frequenz-actor-example`.\n\n* `github_repo_name`: The handle of the GitHub repository where the project\n  will reside. This will be used to generate links to the project on GitHub and\n  as the top-level directory name.\n\n* `default_codeowners`: A space-separated list of GitHub teams (`@org/team`) or\n  users (`@user`) that will be the default code owners for this project. This\n  will be used to build the `CODEOWNERS` file. Please refer to the [code owners\n  documentation] for more details on the valid syntax.\n\n[code owners documentation]: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners\n\n\n[Please press any key to continue",
+    "type": "api",
+    "name": "microgrid",
+    "description": "Frequenz gRPC API for monitoring and control of microgrids",
+    "title": "Frequenz Microgrid API",
+    "keywords": "(comma separated: 'frequenz', <type> and <name> are included automatically)",
+    "github_org": "frequenz-floss",
+    "license": "MIT",
+    "author_name": "Frequenz Energy-as-a-Service GmbH",
+    "author_email": "floss@frequenz.com",
+    "python_package": "frequenz.api.microgrid",
+    "pypi_package_name": "frequenz-api-microgrid",
+    "github_repo_name": "frequenz-api-microgrid",
+    "default_codeowners": "(like @some-org/some-team; defaults to a team based on the repo type)",
+    "_extensions": [
+      "jinja2_time.TimeExtension",
+      "local_extensions.as_identifier",
+      "local_extensions.default_codeowners",
+      "local_extensions.github_repo_name",
+      "local_extensions.introduction",
+      "local_extensions.keywords",
+      "local_extensions.pypi_package_name",
+      "local_extensions.python_package",
+      "local_extensions.src_path",
+      "local_extensions.title"
+    ],
+    "_template": "gh:frequenz-floss/frequenz-repo-config-python"
+  }
+}

.github/ISSUE_TEMPLATE/bug.yml

@@ -5,7 +5,9 @@ name: Report something is not working properly 🐛
 description:
   Use this if there is something that is not working properly.  If you are not
   sure or you need help making something work, please ask a question instead.
-labels: priority:❓, type:bug
+labels:
+  - "priority:❓"
+  - "type:bug"
 body:
   - type: markdown
     attributes:
@@ -27,21 +29,14 @@ body:
       placeholder: What did you expect to happen.
     validations:
       required: true
-  - type: dropdown
+  - type: input
     id: version
     attributes:
       label: Affected version(s)
       description:
-        Which version(s) have you tried and found this issue in? (if you see
-        this issue **not** happening on any version, please let us know in the
-        "Extra information").
-      multiple: true
-      options:
-        - I don't know (version:❓)
-        - An older version (version:old)
-        - v0.10.x (version:0.10.x)
-    validations:
-      required: true
+        Please add a comma-separated list of the versions affected by this
+        issue.
+      placeholder: 'Example: v0.11.0, v0.12.0'
   - type: dropdown
     id: part
     attributes:
@@ -65,6 +60,6 @@ body:
       label: Extra information
       description:
         Please write here any extra information you think it might be relevant,
-        e.g., if this didn't happened before, or if you suspect where the
-        problem might be.
+        e.g., if this didn't happen before, or if you suspect where the problem
+        might be.
       placeholder: Any extra information you think it might be relevant.

.github/ISSUE_TEMPLATE/feature.yml

@@ -3,7 +3,10 @@
 
 name: Request a feature or enhancement ✨
 description: Use this if something is missing or could be done better or more easily.
-labels: part:❓, priority:❓, type:enhancement
+labels:
+  - "part:❓"
+  - "priority:❓"
+  - "type:enhancement"
 body:
   - type: markdown
     attributes:

.github/RELEASE_NOTES.template.md

@@ -1,12 +1,12 @@
-# Frequenz Migrogrid API Release Notes
+# Frequenz Microgrid API Release Notes
 
 ## Summary
 
 <!-- Here goes a general summary of what this release is about -->
 
 ## Upgrading
 
-<!-- Here goes notes on how to upgrade from previous versions, including if there are any deprecations and what they should be replaced with -->
+<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
 
 ## New Features
 

.github/keylabeler.yml

@@ -18,6 +18,3 @@ labelMappings:
   "part:tests": "part:tests"
   "part:tooling": "part:tooling"
   "part:❓": "part:❓"
-  "version:old": "version:old"
-  "version:0.10.x": "version:0.10.x"
-  "version:❓": "version:❓"

.github/labeler.yml

@@ -6,23 +6,26 @@
 # For more details on the configuration please see:
 # https://github.com/marketplace/actions/labeler
 
-"part:docs": 
+"part:docs":
   - "**/*.md"
+  - "docs/**"
+  - "examples/**"
   - LICENSE
 
 "part:tests":
   - "pytests/**"
 
 "part:tooling":
+  - "**/*.ini"
+  - "**/*.toml"
+  - "**/*.yaml"
+  - "**/*.yml"
   - ".git*"
   - ".git*/**"
-  - "**/*.toml"
-  - "**/*.ini"
+  - "docs/*.py"
   - CODEOWNERS
   - MANIFEST.in
-  - "*requirements*.txt"
-  - setup.py
-  - "submodules/*"
+  - noxfile.py
 
 "part:python":
   - "py/**"