Add note about specifying stages when using include
What does this MR do?
This MR updates the docs about stages
to clarify what happens when you do specify stages.
We say:
If you do not define
stages
in the pipeline, you can use the 5 default stages
I'm adding a clarifying note about what happens if you do define stages. It may not be immediately clear to all that when you do define stages, the default stages are not added. This can lead to errors when you manually define stages and then include a template that attempts to add a job to a stage that you have not manually defined.
This is motivated by
We talk about manually adding a test
stage when one is not declared in this troubleshooting section from the application security page but I think we should clarify it here where we talk about defining stages. People will encounter this outside of the CI templates we provide and so may not immediately draw a connection between what they are doing and the linked troubleshooting section.
Note: I am happy for any and all improvements to the wording I have proposed.
Screenshots (strongly suggested)
Does this MR meet the acceptance criteria?
Conformity
-
📋 Does this MR need a changelog?-
I have included a changelog entry. -
I have not included a changelog entry because this is a documentation-only change.
-
-
Documentation (if required) -
Code review guidelines -
Merge request performance guidelines -
Style guides -
Database guides -
Separation of EE specific content
Availability and Testing
-
Review and add/update tests for this feature/bug. Consider all test levels. See the Test Planning Process. -
Tested in all supported browsers -
Informed Infrastructure department of a default or new setting change, if applicable per definition of done
Security
If this MR contains changes to processing or storing of credentials or tokens, authorization and authentication methods and other items described in the security review guidelines:
-
Label as security and @ mention @gitlab-com/gl-security/appsec
-
The MR includes necessary changes to maintain consistency between UI, API, email, or other methods -
Security reports checked/validated by a reviewer from the AppSec team