You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
## 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]](diffhunk://#diff-3ab46ee209a127470fce3c2cf106b1a1dbadbb929a4b5b13656a4bc4ce19c0b8L199-L203);
`.github/workflows/workflow.yml`,
[[2]](diffhunk://#diff-126bf89616b7daa3d14ebc882ad18666aaf1c3dae888c4ba306a66ec80758bc1L206-L210).
### Documentation Handling:
* Added steps to commit all changes and lint documentation using the
`super-linter` action (`.github/workflows/CI.yml`,
[[1]](diffhunk://#diff-3ab46ee209a127470fce3c2cf106b1a1dbadbb929a4b5b13656a4bc4ce19c0b8R262-R372);
`.github/workflows/workflow.yml`,
[[2]](diffhunk://#diff-126bf89616b7daa3d14ebc882ad18666aaf1c3dae888c4ba306a66ec80758bc1R269-R379).
* Introduced steps to install `mkdocs-material` and related plugins,
structure the site, and build the documentation site
(`.github/workflows/CI.yml`,
[[1]](diffhunk://#diff-3ab46ee209a127470fce3c2cf106b1a1dbadbb929a4b5b13656a4bc4ce19c0b8R262-R372);
`.github/workflows/workflow.yml`,
[[2]](diffhunk://#diff-126bf89616b7daa3d14ebc882ad18666aaf1c3dae888c4ba306a66ec80758bc1R269-R379).
### Artifact Management:
* Added steps to configure GitHub Pages and upload the built site as an
artifact (`.github/workflows/CI.yml`,
[[1]](diffhunk://#diff-3ab46ee209a127470fce3c2cf106b1a1dbadbb929a4b5b13656a4bc4ce19c0b8R262-R372);
`.github/workflows/workflow.yml`,
[[2]](diffhunk://#diff-126bf89616b7daa3d14ebc882ad18666aaf1c3dae888c4ba306a66ec80758bc1R269-R379).
### Fetch Depth Configuration:
* Updated the `checkout` action to use `fetch-depth: 0` to ensure the
full history is available (`.github/workflows/CI.yml`,
[[1]](diffhunk://#diff-3ab46ee209a127470fce3c2cf106b1a1dbadbb929a4b5b13656a4bc4ce19c0b8R235-R236)
[[2]](diffhunk://#diff-3ab46ee209a127470fce3c2cf106b1a1dbadbb929a4b5b13656a4bc4ce19c0b8R384-R385);
`.github/workflows/workflow.yml`,
[[3]](diffhunk://#diff-126bf89616b7daa3d14ebc882ad18666aaf1c3dae888c4ba306a66ec80758bc1R242-R243)
[[4]](diffhunk://#diff-126bf89616b7daa3d14ebc882ad18666aaf1c3dae888c4ba306a66ec80758bc1R269-R379).
### Removal of Redundant Jobs:
* Removed the `LintDocs` and `BuildSite` jobs, consolidating their steps
into the main workflow (`.github/workflows/CI.yml`,
[.github/workflows/CI.ymlL545-L709](diffhunk://#diff-3ab46ee209a127470fce3c2cf106b1a1dbadbb929a4b5b13656a4bc4ce19c0b8L545-L709)).
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
<!-- Use the check-boxes [x] on the options that are relevant. -->
- [ ] 📖 [Docs]
- [ ] 🪲 [Fix]
- [x] 🩹 [Patch]
- [ ] ⚠️ [Security fix]
- [ ] 🚀 [Feature]
- [ ] 🌟 [Breaking change]
## Checklist
<!-- Use the check-boxes [x] on the options that are relevant. -->
- [x] I have performed a self-review of my own code
- [x] I have commented my code, particularly in hard-to-understand areas
0 commit comments