mirror of
				https://github.com/actions/setup-dotnet.git
				synced 2025-11-04 04:53:45 +00:00 
			
		
		
		
	Update docs to v2
This commit is contained in:
		
							parent
							
								
									9211491ffb
								
							
						
					
					
						commit
						f3275be279
					
				
							
								
								
									
										20
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										20
									
								
								README.md
									
									
									
									
									
								
							@ -24,7 +24,7 @@ Basic:
 | 
				
			|||||||
```yaml
 | 
					```yaml
 | 
				
			||||||
steps:
 | 
					steps:
 | 
				
			||||||
- uses: actions/checkout@v2
 | 
					- uses: actions/checkout@v2
 | 
				
			||||||
- uses: actions/setup-dotnet@v1
 | 
					- uses: actions/setup-dotnet@v2
 | 
				
			||||||
  with:
 | 
					  with:
 | 
				
			||||||
    dotnet-version: '3.1.x' # SDK Version to use; x will use the latest version of the 3.1 channel
 | 
					    dotnet-version: '3.1.x' # SDK Version to use; x will use the latest version of the 3.1 channel
 | 
				
			||||||
- run: dotnet build <my project>
 | 
					- run: dotnet build <my project>
 | 
				
			||||||
@ -36,7 +36,7 @@ Multiple versions:
 | 
				
			|||||||
steps:
 | 
					steps:
 | 
				
			||||||
- uses: actions/checkout@v2
 | 
					- uses: actions/checkout@v2
 | 
				
			||||||
- name: Setup dotnet
 | 
					- name: Setup dotnet
 | 
				
			||||||
  uses: actions/setup-dotnet@v1
 | 
					  uses: actions/setup-dotnet@v2
 | 
				
			||||||
  with:
 | 
					  with:
 | 
				
			||||||
    dotnet-version: | 
 | 
					    dotnet-version: | 
 | 
				
			||||||
      3.1.x
 | 
					      3.1.x
 | 
				
			||||||
@ -47,7 +47,7 @@ Preview version:
 | 
				
			|||||||
```yml
 | 
					```yml
 | 
				
			||||||
steps:
 | 
					steps:
 | 
				
			||||||
- uses: actions/checkout@v2
 | 
					- uses: actions/checkout@v2
 | 
				
			||||||
- uses: actions/setup-dotnet@v1
 | 
					- uses: actions/setup-dotnet@v2
 | 
				
			||||||
  with:
 | 
					  with:
 | 
				
			||||||
    dotnet-version: '6.0.x'
 | 
					    dotnet-version: '6.0.x'
 | 
				
			||||||
    include-prerelease: true
 | 
					    include-prerelease: true
 | 
				
			||||||
@ -66,7 +66,7 @@ jobs:
 | 
				
			|||||||
    steps:
 | 
					    steps:
 | 
				
			||||||
      - uses: actions/checkout@v2
 | 
					      - uses: actions/checkout@v2
 | 
				
			||||||
      - name: Setup dotnet
 | 
					      - name: Setup dotnet
 | 
				
			||||||
        uses: actions/setup-dotnet@v1
 | 
					        uses: actions/setup-dotnet@v2
 | 
				
			||||||
        with:
 | 
					        with:
 | 
				
			||||||
          dotnet-version: ${{ matrix.dotnet }}
 | 
					          dotnet-version: ${{ matrix.dotnet }}
 | 
				
			||||||
      - run: dotnet build <my project>
 | 
					      - run: dotnet build <my project>
 | 
				
			||||||
@ -81,11 +81,11 @@ jobs:
 | 
				
			|||||||
    steps:
 | 
					    steps:
 | 
				
			||||||
      - uses: actions/checkout@v2
 | 
					      - uses: actions/checkout@v2
 | 
				
			||||||
      - name: Setup dotnet
 | 
					      - name: Setup dotnet
 | 
				
			||||||
        uses: actions/setup-dotnet@v1
 | 
					        uses: actions/setup-dotnet@v2
 | 
				
			||||||
        with:
 | 
					        with:
 | 
				
			||||||
          dotnet-version: '2.1.x'
 | 
					          dotnet-version: '2.1.x'
 | 
				
			||||||
      - name: Setup dotnet
 | 
					      - name: Setup dotnet
 | 
				
			||||||
        uses: actions/setup-dotnet@v1
 | 
					        uses: actions/setup-dotnet@v2
 | 
				
			||||||
        with:
 | 
					        with:
 | 
				
			||||||
          dotnet-version: '3.1.x'
 | 
					          dotnet-version: '3.1.x'
 | 
				
			||||||
      - run: dotnet build <my project>
 | 
					      - run: dotnet build <my project>
 | 
				
			||||||
@ -97,7 +97,7 @@ Authentication for nuget feeds:
 | 
				
			|||||||
steps:
 | 
					steps:
 | 
				
			||||||
- uses: actions/checkout@v2
 | 
					- uses: actions/checkout@v2
 | 
				
			||||||
# Authenticates packages to push to GPR
 | 
					# Authenticates packages to push to GPR
 | 
				
			||||||
- uses: actions/setup-dotnet@v1
 | 
					- uses: actions/setup-dotnet@v2
 | 
				
			||||||
  with:
 | 
					  with:
 | 
				
			||||||
    dotnet-version: '3.1.x' # SDK Version to use.
 | 
					    dotnet-version: '3.1.x' # SDK Version to use.
 | 
				
			||||||
    source-url: https://nuget.pkg.github.com/<owner>/index.json
 | 
					    source-url: https://nuget.pkg.github.com/<owner>/index.json
 | 
				
			||||||
@ -110,7 +110,7 @@ steps:
 | 
				
			|||||||
  run: dotnet nuget push <my project>/bin/Release/*.nupkg
 | 
					  run: dotnet nuget push <my project>/bin/Release/*.nupkg
 | 
				
			||||||
 | 
					
 | 
				
			||||||
# Authenticates packages to push to Azure Artifacts
 | 
					# Authenticates packages to push to Azure Artifacts
 | 
				
			||||||
- uses: actions/setup-dotnet@v1
 | 
					- uses: actions/setup-dotnet@v2
 | 
				
			||||||
  with:
 | 
					  with:
 | 
				
			||||||
    source-url: https://pkgs.dev.azure.com/<your-organization>/_packaging/<your-feed-name>/nuget/v3/index.json
 | 
					    source-url: https://pkgs.dev.azure.com/<your-organization>/_packaging/<your-feed-name>/nuget/v3/index.json
 | 
				
			||||||
  env:
 | 
					  env:
 | 
				
			||||||
@ -120,7 +120,7 @@ steps:
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
# Authenticates packages to push to nuget.org.
 | 
					# Authenticates packages to push to nuget.org.
 | 
				
			||||||
# It's only the way to push a package to nuget.org feed for macOS/Linux machines due to API key config store limitations.
 | 
					# It's only the way to push a package to nuget.org feed for macOS/Linux machines due to API key config store limitations.
 | 
				
			||||||
- uses: actions/setup-dotnet@v1
 | 
					- uses: actions/setup-dotnet@v2
 | 
				
			||||||
  with:
 | 
					  with:
 | 
				
			||||||
    dotnet-version: 3.1.x
 | 
					    dotnet-version: 3.1.x
 | 
				
			||||||
- name: Publish the package to nuget.org
 | 
					- name: Publish the package to nuget.org
 | 
				
			||||||
@ -145,7 +145,7 @@ build:
 | 
				
			|||||||
    DOTNET_NOLOGO: true
 | 
					    DOTNET_NOLOGO: true
 | 
				
			||||||
  steps:
 | 
					  steps:
 | 
				
			||||||
    - uses: actions/checkout@main
 | 
					    - uses: actions/checkout@main
 | 
				
			||||||
    - uses: actions/setup-dotnet@v1
 | 
					    - uses: actions/setup-dotnet@v2
 | 
				
			||||||
      with:
 | 
					      with:
 | 
				
			||||||
        dotnet-version: '3.1.x' # SDK Version to use.
 | 
					        dotnet-version: '3.1.x' # SDK Version to use.
 | 
				
			||||||
```
 | 
					```
 | 
				
			||||||
 | 
				
			|||||||
@ -26,9 +26,9 @@ With any contribution please take time to consider how this can be tested to mai
 | 
				
			|||||||
## Creating new version
 | 
					## Creating new version
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Details on versioning can be found here: https://github.com/actions/toolkit/blob/main/docs/action-versioning.md
 | 
					Details on versioning can be found here: https://github.com/actions/toolkit/blob/main/docs/action-versioning.md
 | 
				
			||||||
Create a new release using the UI. Version format should be `v1.x.x`. Creating a new major version requires reaction from users and should be done only with breaking changes.
 | 
					Create a new release using the UI. Version format should be `v2.x.x`. Creating a new major version requires reaction from users and should be done only with breaking changes.
 | 
				
			||||||
Once the new release is created, the v1 tag needs to be updated as well.
 | 
					Once the new release is created, the v2 tag needs to be updated as well.
 | 
				
			||||||
```
 | 
					```
 | 
				
			||||||
git tag -fa v1 -m "Update v1 tag"
 | 
					git tag -fa v2 -m "Update v2 tag"
 | 
				
			||||||
git push origin v1 --force
 | 
					git push origin v2 --force
 | 
				
			||||||
```
 | 
					```
 | 
				
			||||||
 | 
				
			|||||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user