Code Monkey home page Code Monkey logo

psrule.rules.msft.oss's Introduction

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.

Open in vscode.dev

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/[email protected]
      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 [email protected] with any additional questions or comments.

Maintainers

License

This project is licensed under the MIT License.

psrule.rules.msft.oss's People

Contributors

berniewhite avatar dependabot[bot] avatar github-actions[bot] avatar microsoft-github-operations[bot] avatar microsoftopensource avatar

Stargazers

avatar avatar avatar avatar avatar avatar avatar avatar

Watchers

avatar avatar avatar avatar avatar

Forkers

berniewhite armaanmcleod isabella232 seanpm2001

psrule.rules.msft.oss's Issues

Add check for support.md

Rule request

Suggested rule change

The standard community file SUPPORT.md should be included in repositories.

Add support for Dockerfile

Rule request

Suggested rule change

Checks in MSFT.OSS.License don't apply to Dockerfile file types. These should be included.

Also add .rb, .bicep, .bat, and .cmd.

ACTION REQUIRED: Microsoft needs this private repository to complete compliance info

There are open compliance tasks that need to be reviewed for your PSRule.Rules.MSFT.OSS repo.

Action required: 4 compliance tasks

To bring this repository to the standard required for 2021, we require administrators of this and all Microsoft GitHub repositories to complete a small set of tasks within the next 60 days. This is critical work to ensure the compliance and security of your microsoft GitHub organization.

Please take a few minutes to complete the tasks at: https://repos.opensource.microsoft.com/orgs/microsoft/repos/PSRule.Rules.MSFT.OSS/compliance

  • The GitHub AE (GitHub inside Microsoft) migration survey has not been completed for this private repository
  • No Service Tree mapping has been set for this repo. If this team does not use Service Tree, they can also opt-out of providing Service Tree data in the Compliance tab.
  • No repository maintainers are set. The Open Source Maintainers are the decision-makers and actionable owners of the repository, irrespective of administrator permission grants on GitHub.
  • Classification of the repository as production/non-production is missing in the Compliance tab.

You can close this work item once you have completed the compliance tasks, or it will automatically close within a day of taking action.

If you no longer need this repository, it might be quickest to delete the repo, too.

GitHub inside Microsoft program information

More information about GitHub inside Microsoft and the new GitHub AE product can be found at https://aka.ms/gim.

FYI: current admins at Microsoft include @BernieWhite

Rule documentation links are broken

Description of the issue

Rule online links refer to the incorrect location of markdown files. Update links to point to correct locations.

Module in use and version:

  • Module: PSRule.Rules.MSFT.OSS
  • Version: 1.0.0

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.