Add docs for automatin rules #6072
Conversation
docs/Makefile
Outdated
| @@ -2,7 +2,7 @@ | |||
| # | |||
|
|
|||
| # You can set these variables from the command line. | |||
| SPHINXOPTS = -W --keep-going | |||
| SPHINXOPTS = -W | |||
There was a problem hiding this comment.
This causes make livehtml to fail
| - Action: ``Activate version on match`` | ||
|
|
||
| Activate all new tags that don't contain the ``-nightly`` suffix | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
There was a problem hiding this comment.
If this is a very common case, we can add new actions like Activate versions that don't match
There was a problem hiding this comment.
Or an option for the rule like Match or Not match
There was a problem hiding this comment.
I would remove this example from the docs for now. Looks pretty complex to me and I'm not sure how many cases there are where -nightly is a tag.
There was a problem hiding this comment.
The section is supposed to have complex examples, more than the suffix, is to have an example of how apply a rule on not-match
There was a problem hiding this comment.
I'm suggesting #6354 to make this more easy
There was a problem hiding this comment.
Looks good to me.
I think it would be good to start explaining what is each thing as a first paragraph of each section and then talk about it's limitation, the supported values and more advanced things. As a reader, it's important to know what a "Match" field is and then know what I can write on it.
Also, since the docs talks about "Creating a rule", it may be good to explain how to Delete a rule and what happens with the order in that case, for example.
| - Action: ``Activate version on match`` | ||
|
|
||
| Activate all new tags that don't contain the ``-nightly`` suffix | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
There was a problem hiding this comment.
I would remove this example from the docs for now. Looks pretty complex to me and I'm not sure how many cases there are where -nightly is a tag.
|
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions. |
Co-Authored-By: Anthony <[email protected]>
it's already described on `How do they work?`
Closes #6059
Should be merged after #5996 and friends are merged