-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Upgrade packages. Output two new values. Update README.md and action.yml. Modernize. * Apply suggestions from code review Co-authored-by: Genevieve Warren <[email protected]> --------- Co-authored-by: Genevieve Warren <[email protected]>
- Loading branch information
1 parent
5b5aefb
commit fd9dd57
Showing
26 changed files
with
415 additions
and
211 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,11 +1,11 @@ | ||
| # 🎯 LTS (or current) versions | ||
| ## .NET version sweeper | ||
| # 🎯 LTS (or STS) versions | ||
| ## .NET version sweeper | ||
|
|
||
| [](https://github.com/dotnet/versionsweeper/actions/workflows/build-and-test.yml) | ||
| [](https://github.com/dotnet/versionsweeper/actions/workflows/dog-food.yml) | ||
| [](https://github.com/dotnet/versionsweeper/actions/workflows/codeql-analysis.yml) | ||
| [](https://github.com/marketplace/actions/net-version-sweeper) | ||
| [](https://github.com/dotnet/versionsweeper/blob/main/LICENSE) | ||
| [](https://github.com/marketplace/actions/net-version-sweeper) | ||
| [](https://github.com/dotnet/versionsweeper/blob/main/LICENSE) | ||
| [](https://GitHub.com/dotnet/versionsweeper/graphs/contributors/) | ||
| [](https://github.com/dotnet/versionsweeper) | ||
| [](https://GitHub.com/dotnet/versionsweeper/issues?q=is%3Aissue+is%3Aopened) | ||
|
|
@@ -16,7 +16,7 @@ | |
|
|
||
| ## Get started | ||
|
|
||
| The .NET version sweeper is designed to alert repositories that there are projects targeting versions that are no longer supported. For example, projects targeting .NET Core 3.0, or .NET Framework 4.5.1 would trigger an issue to be created to update these non-LTS or current versions. For example issues, see [issues created in this repo based on the *non-lts* directory](https://github.com/dotnet/versionsweeper/issues?q=is%3Aopen+is%3Aissue+label%3Adotnet-target-version). | ||
| The .NET version sweeper is designed to alert repositories (by either creating issues, pull requests, or both) that there are projects targeting versions that are no longer supported (or won't be soon). For example, projects targeting .NET Core 3.0 or .NET Framework 4.5.1 could trigger an issue to be created to update these projects to supported versions, or even a pull request that upgrades it for you. For example issues, see [issues created in this repo based on the *non-lts* directory](https://github.com/dotnet/versionsweeper/issues?q=is%3Aopen+is%3Aissue+label%3Adotnet-target-version). | ||
|
|
||
| This is intended to be used as a GitHub action that will run as a [scheduled CRON job](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#onschedule). Ideally, once a month or as often as necessary to align with .NET version updates. | ||
|
|
||
|
|
@@ -39,56 +39,103 @@ A schedule/cron job that runs on the first of every month is detailed below in t | |
| | `-p`, `pattern` | The search pattern, defaults to `"*.csproj;*.fsproj;*.vbproj;*.xproj;project.json"`. | | ||
| | `-s`, `sdk-compliance` | Whether or not to report projects that are not using the new SDK-style project format. | | ||
|
|
||
| ## GitHub Action outputs | ||
|
|
||
| | Output | Type | Details | | ||
| |:---------------------|:-----------|:-----------------------------------------------------------------------------------------------------------| | ||
| | `has-remaining-work` | `bool` | When `true`, the `upgrade-projects` array will be populated with project directories that require upgrade. | | ||
| | `upgrade-projects` | `string[]` | An array of project directories that are in need of being upgraded. | | ||
|
|
||
| > **Note** | ||
| > Outputs are only present when configured to run as pull request mode. For more information, see [Configure action](#configure-action). | ||
| ## Example workflow | ||
|
|
||
| ```yml | ||
| # The name used in the GitHub UI for the workflow | ||
| name: '.net version sweeper' | ||
| # This is a basic workflow to help you get started with Actions | ||
|
|
||
| # When to run this action: | ||
| # - Scheduled on the first of every month | ||
| # - Manually runable from the GitHub UI with a reason | ||
| name: "target supported version" | ||
|
|
||
| # Controls when the action will run. | ||
| on: | ||
| # Triggers the workflow on push or pull request events but only for the default branch | ||
| schedule: | ||
| - cron: '0 0 1 * *' | ||
| - cron: "0 0 1 * *" | ||
| workflow_dispatch: | ||
| inputs: | ||
| reason: | ||
| description: 'The reason for running the workflow' | ||
| description: "The reason for running the workflow" | ||
| required: true | ||
| default: "Manual run" | ||
| support: | ||
| description: "The support level to target (STS, LTS, or Preview)." | ||
| required: true | ||
| default: 'Manual run' | ||
| default: "STS" | ||
|
|
||
| # Run on the latest version of Ubuntu | ||
| # A workflow run is made up of one or more jobs that can run sequentially or in parallel | ||
| jobs: | ||
| # This workflow contains a single job called "build" | ||
| version-sweep: | ||
| # The type of runner that the job will run on | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| contents: read | ||
| issues: write | ||
| statuses: write | ||
| pull-requests: write | ||
|
|
||
| # Checkout the repo into the workspace within the VM | ||
| # Steps represent a sequence of tasks that will be executed as part of the job | ||
| steps: | ||
| - uses: actions/checkout@v2 | ||
|
|
||
| # If triggered manually, print the reason why | ||
| - name: 'Print manual run reason' | ||
| if: ${{ github.event_name == 'workflow_dispatch' }} | ||
| run: | | ||
| echo "Reason: ${{ github.event.inputs.reason }}" | ||
| # Run the .NET version sweeper | ||
| # Issues will be automatically created for any non-ignored projects that are targeting non-LTS versions | ||
| - name: .NET version sweeper | ||
| id: dotnet-version-sweeper | ||
| uses: dotnet/[email protected] | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| with: | ||
| owner: ${{ github.repository_owner }} | ||
| name: ${{ github.repository }} | ||
| branch: ${{ github.ref }} | ||
| sdkCompliance: true | ||
| # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it | ||
| - uses: actions/checkout@v3 | ||
|
|
||
| # Runs a single command using the runners shell | ||
| - name: "Print manual run reason" | ||
| if: ${{ github.event_name == 'workflow_dispatch' }} | ||
| run: | | ||
| echo 'Reason: ${{ github.event.inputs.reason }}' | ||
| # Start the .NET version sweeper, scan projects/slns for non-LTS (or currrent) versions | ||
| - name: .NET version sweeper | ||
| id: dotnet-version-sweeper | ||
| uses: dotnet/versionsweeper@main | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| with: | ||
| owner: ${{ github.repository_owner }} | ||
| name: ${{ github.repository }} | ||
| branch: ${{ github.ref }} | ||
|
|
||
| - name: Create pull requests | ||
| if: steps.dotnet-version-sweeper.outputs.has-remaining-work == 'true' | ||
| run: | | ||
| upgradeProjects: ${{ steps.dotnet-version-sweeper.outputs.upgrade-projects }} | ||
| # Install .NET Upgrade Assistant global tool | ||
| dotnet tool install --global upgrade-assistant | ||
| # Iterate all upgrade projects | ||
| for projectDir in "${upgradeProjects[@]}"; do | ||
| echo "Project Directory: $projectDir" | ||
| # Create a new branch | ||
| git checkout -b upgrade/$projectDir | ||
| # Perform the upgrade using upgrade-assistant | ||
| upgrade-assistant upgrade "$projectDir" --non-interactive -t ${{ inputs.support }} | ||
| # Commit the changes | ||
| git add . | ||
| git commit -m ".NET Version Sweeper: Upgraded $projectDir" | ||
| # Push the branch to the repository | ||
| git push origin upgrade/$projectDir | ||
| # Create a pull request | ||
| gh pr create \ | ||
| --base main \ | ||
| --head upgrade/$projectDir \ | ||
| --title "Upgraded $projectDir" \ | ||
| --body "Proposed upgrade for $projectDir" | ||
| done | ||
| ``` | ||
| ## Project and solution discovery | ||
|
|
@@ -102,6 +149,13 @@ The .NET version sweeper currently supports reporting on all of the following ty | |
| - Project JSON files: `project.json` | ||
| - Solution files: `*.sln` | ||
|
|
||
| ## Dockerfile discovery | ||
|
|
||
| The .NET version sweeper also supports reporting _Dockerfile_ target frameworks that are out-of-support, or soon to be, for example: | ||
|
|
||
| - `FROM mcr.microsoft.com/dotnet/framework/aspnet:4.8` | ||
| - `COPY --from=mcr.microsoft.com/dotnet/framework/runtime:3.5-20221011-windowsservercore-ltsc2019` | ||
|
|
||
| ## Configure action | ||
|
|
||
| To configure the action, you can create a file at the root of the repository named *dotnet-versionsweeper.json*. This config file contains a node, named `"ignore"` that is an array of patterns following the [globbing matcher detailed here](https://docs.microsoft.com/dotnet/api/microsoft.extensions.filesystemglobbing.matcher#remarks). | ||
|
|
@@ -115,12 +169,19 @@ The file can also contain a value `outOfSupportWithinDays` to specify the number | |
| "**/*ThisShouldNeverBeFlagged.csproj", | ||
| "IgnoreDir/**/*.*" | ||
| ], | ||
| "outOfSupportWithinDays": 90 | ||
| "outOfSupportWithinDays": 90, | ||
| "actionType": "All" | ||
| } | ||
| ``` | ||
|
|
||
| For an example config file, see [dotnet/samples/dotnet-versionsweeper.json](https://github.com/dotnet/samples/blob/master/dotnet-versionsweeper.json). | ||
|
|
||
| | Configuration | Type | Details | | ||
| |:--|:--|:--| | ||
| | `ignore` | `string[]` | Glob patterns to ignore. | | ||
| | `outOfSupportWithinDays` | `string[]` | The number of days in advance to monitor for. | | ||
| | `actionType` | `ActionType` <br><br> `"CreateIssue"` <br> `"PullRequest"` <br> `"All"` | The type of action to take, defaults to `CreateIssue`. | | ||
|
|
||
| ## Label auto-generation | ||
|
|
||
| This tool will create a label named `dotnet-target-version` for easier tracking of issues and pull requests that it creates. The label is created with the following description and color by default, please do not change the name - as that is what is used to determine whether or not to create a new label. | ||
|
|
@@ -140,7 +201,7 @@ This repo serves as a sample, as it contains a directory *non-lts* with projects | |
|
|
||
| ## Official .NET support policies | ||
|
|
||
| This action is intended to help determine non-LTS (or current) versions, but it is _not_ perfect. When in doubt, please refer to the [official .NET support policies](https://dotnet.microsoft.com/platform/support/policy). | ||
| This action is intended to help determine non-LTS (or STS) versions, but it _isn't_ perfect. When in doubt, please refer to the [official .NET support policies](https://dotnet.microsoft.com/platform/support/policy). | ||
|
|
||
| ## Acknowledgements | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.