mirror of
https://github.com/pezkuwichain/labels.git
synced 2026-04-22 06:37:56 +00:00
Initial labels setup for Pezkuwi SDK
This commit is contained in:
@@ -0,0 +1 @@
|
||||
book
|
||||
@@ -0,0 +1,7 @@
|
||||
# Summary
|
||||
|
||||
[Home](HOME.md)
|
||||
|
||||
- [Respositories](#)
|
||||
- [Polkadot SDK](doc_polkadot-sdk.md)
|
||||
- [FAQ](faq.md)
|
||||
@@ -0,0 +1,12 @@
|
||||
[book]
|
||||
authors = ["Chevdor"]
|
||||
language = "en"
|
||||
multilingual = false
|
||||
src = "src"
|
||||
title = "Labels"
|
||||
|
||||
[output.html]
|
||||
site-url = "/labels/"
|
||||
git-repository-url = "https://github.com/paritytech/labels"
|
||||
git-repository-icon = "fa-github"
|
||||
edit-url-template = "https://github.com/paritytech/labels/edit/main/{path}"
|
||||
@@ -0,0 +1,31 @@
|
||||
# FAQ
|
||||
|
||||
## How is a label interpreted ?
|
||||
|
||||
You may see labels defined as `S0-design`. It is made of a label code: `S`, a number: `0` and some description.
|
||||
The rules **only apply to the part of the label without the description and the label above will simply be considered as `S0`.
|
||||
Should the description change, the rules would remain unaffected.
|
||||
|
||||
## What are rules ?
|
||||
|
||||
Rules are defined in a YAML files and describe:
|
||||
- the name of the rule
|
||||
- the conditions of the rule (for instance, some rules only apply if a specific label is present)
|
||||
- the conditions for a set of labels to be valid. For instance, you will not be able to have `C1-low` and `C5-high` for a given PR. You will have to chose one or the other and the rules will enforce this
|
||||
|
||||
## Where can I find the source of the rules ?
|
||||
|
||||
Look for the `specs_<name>.yaml` files in [here](https://github.com/paritytech/labels/tree/main/ruled_labels).
|
||||
|
||||
## Are there tests to check those rules ?
|
||||
|
||||
Absolutly, look for the `tests_<name>.yaml` files in [here](https://github.com/paritytech/labels/tree/main/ruled_labels).
|
||||
|
||||
## Where can I report issues/doubts I have about some rules ?
|
||||
|
||||
You can open a new issue in the [labels repository](https://github.com/paritytech/labels/issues).
|
||||
|
||||
## What happens when rules fail ?
|
||||
|
||||
If you label your PR with an invalid set of labels, the CI will fail and tell you what the issue is.
|
||||
You can see an example [here](https://github.com/paritytech/cumulus/actions/runs/4362797055/jobs/7628115688) where a `B` label was missing.
|
||||
Reference in New Issue
Block a user