Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: PSModule/Process-PSModule
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: v3.2.14
Choose a base ref
...
head repository: PSModule/Process-PSModule
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: v3
Choose a head ref
  • 3 commits
  • 24 files changed
  • 1 contributor

Commits on Feb 13, 2025

  1. 🩹 [Patch]: Merge Docs jobs into one (#136)

    ## 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
    MariusStorhaug authored Feb 13, 2025
    Configuration menu
    Copy the full SHA
    da1f460 View commit details
    Browse the repository at this point in the history

Commits on Feb 14, 2025

  1. 🪲 [Fix]: Fix an issue that break the workflow when there is nothing t…

    …o commit in `BuildDocs` (#137)
    
    ## Description
    
    This pull request updates the reusable workflow files to handle docs
    generation without errors.
    
    Improvements to reusable workflows (CI.yml and workflow.yml) :
    
    * In "BuildDocs":
    * Added `continue-on-error: true` and changed the shell to `pwsh` for
    the "Commit all changes" step. Also added commands to temporarily rename
    the `.gitignore` file during the commit process.
    
    ## Type of change
    
    <!-- Use the check-boxes [x] on the options that are relevant. -->
    
    - [ ] 📖 [Docs]
    - [x] 🪲 [Fix]
    - [ ] 🩹 [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
    MariusStorhaug authored Feb 14, 2025
    Configuration menu
    Copy the full SHA
    175c6b8 View commit details
    Browse the repository at this point in the history
  2. 🪲 [Fix]: Fix placement of docs after copy (#138)

    ## Description
    
    This pull request includes improvements to the `CI.yml` and
    `workflow.yml` reusable workflows.
    
    * Modified the `Copy-Item` command to include all files in the source
    directory by appending `/*` to the path.
    * Added a `try-catch` block around the `git add` and `git commit`
    commands to handle cases where there are no changes to commit,
    preventing errors.
    
    ## Type of change
    
    <!-- Use the check-boxes [x] on the options that are relevant. -->
    
    - [ ] 📖 [Docs]
    - [x] 🪲 [Fix]
    - [ ] 🩹 [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
    MariusStorhaug authored Feb 14, 2025
    Configuration menu
    Copy the full SHA
    44ceccb View commit details
    Browse the repository at this point in the history
Loading