Skip to content
This repository was archived by the owner on Jun 30, 2026. It is now read-only.

docs: add CI/CD workflows documentation (test-feature-branch) - #263

Closed
Romuald Lemesle (RomuDeuxfois) wants to merge 2 commits into
mainfrom
docs/ci-cd-workflows
Closed

Romuald Lemesle (RomuDeuxfois) wants to merge 2 commits into
mainfrom
docs/ci-cd-workflows

Conversation

@RomuDeuxfois

Copy link
Copy Markdown
Member

Summary

Adds documentation for the CI/CD workflows used in OpenAEV development, specifically the test-feature-branch workflow 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-branch workflow. 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.md

  • Overview of available GitHub Actions workflows
  • Detailed usage guide for the test-feature-branch workflow:
    • How to trigger via the Actions tab
    • Input parameters and their constraints
    • What the workflow does (build → containerize → deploy)
    • Staging URL format
  • Troubleshooting section covering:
    • "Not valid JSON or YAML" errors (most common issue)
    • Branch name special character issues
    • Empty Docker digest errors
    • Build failures in the Alpine environment

Updated: mkdocs.yml

  • Added "CI/CD Workflows" entry under the Development section in the navigation

Checklist

  • Follows documentation writing guidelines (active voice, usage-driven)
  • Includes admonitions (warnings, tips, info)
  • Code blocks with syntax highlighting
  • Navigation updated in mkdocs.yml

🤖 [AI-generated] — Created by Doc Agent based on a documentation gap identified in Teams.

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.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant