PSRule.Rules.MSFT.OSS/README.md

PSRule for Microsoft OSS

A suite of rules to validate repositories against Microsoft Open Source Software (OSS) requirements. This module is intended to be used by Microsoft repositories, and also serves as a functional example.

Support

This project uses GitHub Issues to track bugs and feature requests. Please search the existing issues before filing new issues to avoid duplicates.

• For new issues, file your bug or feature request as a new issue.
• For help, discussion, and support questions about using this project, join or start a discussion.

If you have any problems with the PSRule engine, please check the project GitHub issues page instead.

Support for this project/ product is limited to the resources listed above.

Getting started

Using with GitHub Actions

1. See Creating a workflow file.
2. Reference microsoft/ps-rule with modules: 'PSRule.Rules.MSFT.OSS'
3. Optionally, set option prerelease: true to use a pre-release version.

For example:

# Example: .github/workflows/analyze.yaml

#
# Repository validation
#
name: Analyze
on:
- pull_request
jobs:
  analyze:
    name: Analyze repository
    runs-on: ubuntu-latest
    steps:

    - name: Checkout
      uses: actions/checkout@v3

    # Run analysis against repository
    - name: Run PSRule analysis
      uses: microsoft/ps-rule@v2.7.0
      with:
        modules: 'PSRule.Rules.MSFT.OSS'
        prerelease: true

Manual install

This project is designed to be run through a continuous integration (CI) pipeline using GitHub Actions.

Additionally, this module can be manually installed from the PowerShell Gallery. For manual installation see instructions.

Changes and versioning

This repository uses semantic versioning to declare breaking changes. For a list of module changes please see the change log.

Pre-release module versions are created on major commits and can be installed from the PowerShell Gallery. Pre-release versions should be considered experimental. Modules and change log details for pre-releases will be removed as standard releases are made available.

Contributing

This project welcomes contributions and suggestions. If you are ready to contribute, please visit the contribution guide.

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Maintainers

• Bernie White

License

This project is licensed under the MIT License.