Skip to content

Conversation

@MariusStorhaug
Copy link
Member

@MariusStorhaug MariusStorhaug commented Feb 13, 2025

Description

This pull request includes significant updates to the CI/CD workflow configurations in .github/workflows/CI.yml and .github/workflows/workflow.yml. The changes streamline the build process, add new steps for documentation handling, and remove redundant jobs.

Key changes include:

Workflow Simplification:

  • Removed the needs dependencies and conditional checks from the BuildModule job, simplifying the workflow (.github/workflows/CI.yml, [1]; .github/workflows/workflow.yml, [2].

Documentation Handling:

  • Added steps to commit all changes and lint documentation using the super-linter action (.github/workflows/CI.yml, [1]; .github/workflows/workflow.yml, [2].
  • Introduced steps to install mkdocs-material and related plugins, structure the site, and build the documentation site (.github/workflows/CI.yml, [1]; .github/workflows/workflow.yml, [2].

Artifact Management:

  • Added steps to configure GitHub Pages and upload the built site as an artifact (.github/workflows/CI.yml, [1]; .github/workflows/workflow.yml, [2].

Fetch Depth Configuration:

  • Updated the checkout action to use fetch-depth: 0 to ensure the full history is available (.github/workflows/CI.yml, [1] [2]; .github/workflows/workflow.yml, [3] [4].

Removal of Redundant Jobs:

These changes aim to enhance the efficiency and clarity of the CI/CD workflows by reducing complexity and adding necessary steps for documentation management.

Type of change

  • 📖 [Docs]
  • 🪲 [Fix]
  • 🩹 [Patch]
  • ⚠️ [Security fix]
  • 🚀 [Feature]
  • 🌟 [Breaking change]

Checklist

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas

@MariusStorhaug MariusStorhaug self-assigned this Feb 13, 2025
@MariusStorhaug MariusStorhaug requested a review from a team as a code owner February 13, 2025 13:55
… and uncommenting relevant environment variables
@MariusStorhaug MariusStorhaug merged commit da1f460 into main Feb 13, 2025
8 checks passed
@MariusStorhaug MariusStorhaug deleted the mergeDocs branch February 13, 2025 21:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants