docs: add CI/CD workflows documentation (test-feature-branch)#263
Closed
RomuDeuxfois wants to merge 2 commits intomainfrom
Closed
docs: add CI/CD workflows documentation (test-feature-branch)#263RomuDeuxfois wants to merge 2 commits intomainfrom
RomuDeuxfois wants to merge 2 commits intomainfrom
Conversation
Add documentation for GitHub Actions workflows used in the OpenAEV development lifecycle, including the test-feature-branch workflow for staging deployments. Covers: - Overview of available workflows - test-feature-branch workflow usage and input parameters - Common errors and troubleshooting (JSON/YAML validation) - Feature branch URL format
Add the new CI/CD workflows page under the Development section in the site navigation.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds documentation for the CI/CD workflows used in OpenAEV development, specifically the
test-feature-branchworkflow for deploying feature branches to staging environments.Context
This documentation gap was identified from a question in the Engineering/⚙️ CI-CD Teams channel where a contributor encountered a "not valid JSON or YAML" error while using the
test-feature-branchworkflow. No documentation existed to help troubleshoot this common issue.Triggered by: Teams message from Gaël Leblan — GitHub Actions run link
Changes
New page:
docs/development/ci-cd-workflows.mdtest-feature-branchworkflow:Updated:
mkdocs.ymlChecklist
mkdocs.yml🤖 [AI-generated] — Created by Doc Agent based on a documentation gap identified in Teams.