Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Refactor of ImportExcel project #1535

Closed
wants to merge 6 commits into from
Closed

Refactor of ImportExcel project #1535

wants to merge 6 commits into from

Commits on Nov 8, 2023

  1. refactor: Restructure repo and compile PSM1 

    - Move readme, images, examples, and docs under docs folder.
- Move module source under ImportExcel subfolder.
- Simplify use of `Import-LocalizedData` and reformat `strings.psd1`.
- Add `build.ps1` as entry point for local and CI builds.
- Compile .PS1 files into tested & released module to speed up imports.
    @joshooaj
    joshooaj committed Nov 8, 2023
    Configuration menu
    Copy the full SHA
    1a8db95 View commit details
    Browse the repository at this point in the history

  2. refactor: Run tests against compiled module 

    - Add `RunTests.ps1` to configure and invoke Pester for local and CI test runs.
- Update tests so that the compiled version of the module is loaded.
- Fix intermittent failing `Export-Excel` test by supplying a static set of sample file system data.
- Set minimum Pester version to v5.2.0.
- Generate test results in nunit format to be included as annotations in GHA workflow summaries.
    @joshooaj
    joshooaj committed Nov 8, 2023
    Configuration menu
    Copy the full SHA
    850dd91 View commit details
    Browse the repository at this point in the history

  3. refactor: Update GitHub Action workflows 

    - Define separate steps in `ci.yml` for build, test, and publish test results.
- Invoke `build.ps1` to compile module to be tested.
- Invoke `RunTests.ps` to execute Pester tests and save results to `Output/testResults.xml`.
- Run GitHub Action step to publish test results as annotations on the job.
- Add `docs.yml` workflow for building and publishing docs as static site using GitHub Pages.
    @joshooaj
    joshooaj committed Nov 8, 2023
    Configuration menu
    Copy the full SHA
    061d9f3 View commit details
    Browse the repository at this point in the history

  4. refactor: Update docs during build with platyPS 

    - Update `build.ps1` to update existing, and generate new MD help using platyPS.
- Rename lower-case MD files to match the case of commands as exported from module.
- Update numerous links in MD files.
- Add `ImportExcel.md` as "Landing Page" for platyPS in case we setup updatable help later.
- Add `mkdocs.yml`
- Add the `.md` extension to `.gitattributes` to ensure consistent CRLF line endings between platforms.
    @joshooaj
    joshooaj committed Nov 8, 2023
    Configuration menu
    Copy the full SHA
    0dc17c9 View commit details
    Browse the repository at this point in the history

  5. refactor: Add dev container 

    - Add `devcontainer.json` and `Dockerfile` with all dependencies necessary to build and test the module, and work on docs with local web server provided by mkdocs.
- Install platyPS during build if module not available in a local or CI build.
    @joshooaj
    joshooaj committed Nov 8, 2023
    Configuration menu
    Copy the full SHA
    5603d7d View commit details
    Browse the repository at this point in the history

  6. chore: Add launch and default build/test configs

    @joshooaj
    joshooaj committed Nov 8, 2023
    Configuration menu
    Copy the full SHA
    43a283f View commit details
    Browse the repository at this point in the history