Skip to content

Update readme with migration #76

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

Merged
BernieWhite merged 1 commit into from
Apr 23, 2025
Merged

Update readme with migration #76

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Some of the documentation that you might like to improve include:

### Rule recommendations

Before improving rule recommendations familiarize yourself with writing [rule markdown documentation](https://microsoft.github.io/PSRule/scenarios/rule-docs/rule-docs.html#writing-markdown-documentation).
Before improving rule recommendations familiarize yourself with [Writing rule help](https://microsoft.github.io/PSRule/stable/authoring/writing-rule-help/).

Rule documentation requires the following annotations:

Expand Down Expand Up @@ -119,4 +119,4 @@ Thank you for taking the time to contribute.
[github-pr-create]: https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork
[build]: docs/install-instructions.md#building-from-source
[vscode]: https://code.visualstudio.com/
[issues]: https://github.com/Microsoft/PSRule.Rules.MSFT.OSS/issues
[issues]: https://github.com/microsoft/PSRule/issues
24 changes: 13 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,25 +3,27 @@
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](https://img.shields.io/badge/Open%20in-vscode.dev-blue)][1]
> [!NOTE]
> This module is being migrated into <https://github.com/microsoft/PSRule>
> and this repository will be archived in the future.
> _PSRule for Microsoft OSS_ will continue to be installed as a standalone module, however
> will adopt the same versioning and release cadence as _PSRule_.
>
> This repository currently reflects functionality of release v1.1.0.
> Please log any new issues at <https://github.com/microsoft/PSRule/issues>
---

## 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][2].
- For new issues, file your bug or feature request as a new [issue][5].
- For help, discussion, and support questions about using this project, join or start a [discussion][3].

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

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

[1]: https://vscode.dev/github/microsoft/PSRule.Rules.MSFT.OSS
[2]: https://github.com/microsoft/PSRule.Rules.MSFT.OSS/issues
[3]: https://github.com/microsoft/PSRule.Rules.MSFT.OSS/discussions
[4]: https://github.com/microsoft/PSRule
[3]: https://github.com/microsoft/PSRule/discussions
[5]: https://github.com/microsoft/PSRule/issues

## Getting started
Expand Down Expand Up @@ -50,11 +52,11 @@ jobs:
steps:

- name: Checkout
uses: actions/checkout@v3
uses: actions/checkout@v4

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