Skip to content

Commit c684028

Browse files
authored
Update readme with migration (#76)
1 parent 187cad1 commit c684028

2 files changed

Lines changed: 15 additions & 13 deletions

File tree

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Some of the documentation that you might like to improve include:
5454

5555
### Rule recommendations
5656

57-
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).
57+
Before improving rule recommendations familiarize yourself with [Writing rule help](https://microsoft.github.io/PSRule/stable/authoring/writing-rule-help/).
5858

5959
Rule documentation requires the following annotations:
6060

@@ -119,4 +119,4 @@ Thank you for taking the time to contribute.
119119
[github-pr-create]: https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork
120120
[build]: docs/install-instructions.md#building-from-source
121121
[vscode]: https://code.visualstudio.com/
122-
[issues]: https://github.com/Microsoft/PSRule.Rules.MSFT.OSS/issues
122+
[issues]: https://github.com/microsoft/PSRule/issues

README.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,25 +3,27 @@
33
A suite of rules to validate repositories against Microsoft Open Source Software (OSS) requirements.
44
This module is intended to be used by Microsoft repositories, and also serves as a functional example.
55

6-
[![Open in vscode.dev](https://img.shields.io/badge/Open%20in-vscode.dev-blue)][1]
6+
> [!NOTE]
7+
> This module is being migrated into <https://github.com/microsoft/PSRule>
8+
> and this repository will be archived in the future.
9+
> _PSRule for Microsoft OSS_ will continue to be installed as a standalone module, however
10+
> will adopt the same versioning and release cadence as _PSRule_.
11+
>
12+
> This repository currently reflects functionality of release v1.1.0.
13+
> Please log any new issues at <https://github.com/microsoft/PSRule/issues>
14+
---
715

816
## Support
917

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

13-
- For new issues, file your bug or feature request as a new [issue][2].
21+
- For new issues, file your bug or feature request as a new [issue][5].
1422
- For help, discussion, and support questions about using this project, join or start a [discussion][3].
1523

16-
If you have any problems with the [PSRule][4] engine,
17-
please check the project GitHub [issues][5] page instead.
18-
1924
Support for this project/ product is limited to the resources listed above.
2025

21-
[1]: https://vscode.dev/github/microsoft/PSRule.Rules.MSFT.OSS
22-
[2]: https://github.com/microsoft/PSRule.Rules.MSFT.OSS/issues
23-
[3]: https://github.com/microsoft/PSRule.Rules.MSFT.OSS/discussions
24-
[4]: https://github.com/microsoft/PSRule
26+
[3]: https://github.com/microsoft/PSRule/discussions
2527
[5]: https://github.com/microsoft/PSRule/issues
2628

2729
## Getting started
@@ -50,11 +52,11 @@ jobs:
5052
steps:
5153

5254
- name: Checkout
53-
uses: actions/checkout@v3
55+
uses: actions/checkout@v4
5456

5557
# Run analysis against repository
5658
- name: Run PSRule analysis
57-
uses: microsoft/ps-rule@v2.7.0
59+
uses: microsoft/ps-rule@v2.9.0
5860
with:
5961
modules: 'PSRule.Rules.MSFT.OSS'
6062
prerelease: true

0 commit comments

Comments
 (0)