-
Notifications
You must be signed in to change notification settings - Fork 18
feat: implement tag-based deployment with stadium release names (#356) #357
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.
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
Merged
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
a8dc43e
feat: implement tag-based deployment with stadium release names (#356)
nanotaboada 70bde95
fix: address code review suggestions for CD workflow and changelog
nanotaboada 19715e1
feat: validate release tags against stadium list
nanotaboada eefbfbf
fix: remove duplicate changelog from release notes
nanotaboada File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,144 @@ | ||
| # Building, testing, and publishing .NET releases | ||
| # https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-net | ||
|
|
||
| name: .NET CD | ||
|
|
||
| on: | ||
| push: | ||
| tags: | ||
| - 'v*.*.*-*' | ||
|
|
||
| env: | ||
| DOTNET_VERSION: 8.0.x | ||
| PACKAGE_NAME: nanotaboada/dotnet-samples-aspnetcore-webapi | ||
|
|
||
| jobs: | ||
| release: | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| contents: write | ||
| packages: write | ||
|
|
||
| steps: | ||
| - name: Checkout repository | ||
| uses: actions/checkout@v6.0.1 | ||
| with: | ||
| fetch-depth: 0 | ||
|
|
||
| - name: Extract version from tag | ||
| id: version | ||
| run: | | ||
| TAG_NAME=${GITHUB_REF#refs/tags/} | ||
| echo "tag_name=$TAG_NAME" >> $GITHUB_OUTPUT | ||
|
|
||
| # Extract semver (e.g., v1.0.0-azteca -> 1.0.0) | ||
| SEMVER=$(echo $TAG_NAME | sed -E 's/^v([0-9]+\.[0-9]+\.[0-9]+)-.*/\1/') | ||
| echo "semver=$SEMVER" >> $GITHUB_OUTPUT | ||
|
|
||
| # Extract stadium name (e.g., v1.0.0-azteca -> azteca) | ||
| STADIUM=$(echo $TAG_NAME | sed -E 's/^v[0-9]+\.[0-9]+\.[0-9]+-//') | ||
| echo "stadium=$STADIUM" >> $GITHUB_OUTPUT | ||
|
|
||
| echo "📦 Release version: $SEMVER" | ||
| echo "🏟️ Stadium name: $STADIUM" | ||
|
|
||
| - name: Set up .NET ${{ env.DOTNET_VERSION }} | ||
| uses: actions/setup-dotnet@v5.1.0 | ||
| with: | ||
| dotnet-version: ${{ env.DOTNET_VERSION }} | ||
| cache: true | ||
| cache-dependency-path: | | ||
| src/Dotnet.Samples.AspNetCore.WebApi/packages.lock.json | ||
| test/Dotnet.Samples.AspNetCore.WebApi.Tests/packages.lock.json | ||
|
|
||
| - name: Restore dependencies | ||
| run: dotnet restore | ||
|
|
||
| - name: Build projects (Release configuration) | ||
| run: dotnet build --configuration Release --no-restore | ||
|
|
||
| - name: Run tests | ||
| run: dotnet test --configuration Release --no-build --verbosity normal | ||
|
|
||
| - name: Log in to GitHub Container Registry | ||
| uses: docker/login-action@v3.6.0 | ||
| with: | ||
| registry: ghcr.io | ||
| username: ${{ github.actor }} | ||
| password: ${{ secrets.GITHUB_TOKEN }} | ||
|
|
||
| - name: Set up Docker Buildx | ||
| uses: docker/setup-buildx-action@v3.12.0 | ||
|
|
||
| - name: Build and push Docker image to GitHub Container Registry | ||
| uses: docker/build-push-action@v6.18.0 | ||
| with: | ||
| context: . | ||
| push: true | ||
| platforms: linux/amd64 | ||
| provenance: false | ||
| cache-from: type=gha | ||
| cache-to: type=gha,mode=max | ||
| tags: | | ||
| ghcr.io/${{ env.PACKAGE_NAME }}:latest | ||
| ghcr.io/${{ env.PACKAGE_NAME }}:${{ steps.version.outputs.semver }} | ||
| ghcr.io/${{ env.PACKAGE_NAME }}:${{ steps.version.outputs.stadium }} | ||
|
|
||
| - name: Generate changelog | ||
| id: changelog | ||
| run: | | ||
| # Get previous tag | ||
| PREVIOUS_TAG=$(git tag --sort=-version:refname | grep -E '^v[0-9]+\.[0-9]+\.[0-9]+-' | sed -n '2p') | ||
|
|
||
| if [ -z "$PREVIOUS_TAG" ]; then | ||
| echo "📝 First release - no previous tag found" | ||
| CHANGELOG="Initial release" | ||
| else | ||
| echo "📝 Generating changelog from $PREVIOUS_TAG to ${{ steps.version.outputs.tag_name }}" | ||
| CHANGELOG=$(git log --pretty=format:"- %s (%h)" ${PREVIOUS_TAG}..${{ steps.version.outputs.tag_name }}) | ||
| fi | ||
|
|
||
| # Write changelog to file | ||
| echo "$CHANGELOG" > changelog.txt | ||
| cat changelog.txt | ||
|
coderabbitai[bot] marked this conversation as resolved.
|
||
|
|
||
| # Set output for use in release body | ||
| { | ||
| echo "changelog<<EOF" | ||
| echo "$CHANGELOG" | ||
| echo "EOF" | ||
| } >> $GITHUB_OUTPUT | ||
|
|
||
| - name: Create GitHub Release | ||
| uses: softprops/action-gh-release@v2.2.0 | ||
| with: | ||
| name: "v${{ steps.version.outputs.semver }} - ${{ steps.version.outputs.stadium }}" | ||
| tag_name: ${{ steps.version.outputs.tag_name }} | ||
| body: | | ||
| # 🏟️ Release ${{ steps.version.outputs.semver }} - ${{ steps.version.outputs.stadium }} | ||
|
|
||
| ## Docker Images | ||
|
|
||
| Pull this release using any of the following tags: | ||
|
|
||
| ```bash | ||
| # By semantic version (recommended) | ||
| docker pull ghcr.io/${{ env.PACKAGE_NAME }}:${{ steps.version.outputs.semver }} | ||
|
|
||
| # By stadium name | ||
| docker pull ghcr.io/${{ env.PACKAGE_NAME }}:${{ steps.version.outputs.stadium }} | ||
|
|
||
| # Latest | ||
| docker pull ghcr.io/${{ env.PACKAGE_NAME }}:latest | ||
| ``` | ||
|
|
||
| ## Changes | ||
|
|
||
| ${{ steps.changelog.outputs.changelog }} | ||
|
|
||
| --- | ||
|
|
||
| 📦 **Package:** [ghcr.io/${{ env.PACKAGE_NAME }}](https://github.com/${{ github.repository }}/pkgs/container/dotnet-samples-aspnetcore-webapi) | ||
| draft: false | ||
| prerelease: false | ||
| generate_release_notes: true | ||
|
coderabbitai[bot] marked this conversation as resolved.
|
||
This file contains hidden or 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 hidden or 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 |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| # Changelog | ||
|
|
||
| All notable changes to this project will be documented in this file. | ||
|
|
||
| The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), | ||
| and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). | ||
|
|
||
| ## Stadium Release Names | ||
|
|
||
| This project uses famous football stadiums (A-Z) that hosted FIFA World Cup matches (with notable fallbacks where necessary): | ||
|
|
||
| | Letter | Stadium Name | Location | Tag Name | | ||
| | ------ | ----------- | -------- | -------- | | ||
| | A | Azteca | Mexico (1970, 1986, 2026) | `azteca` | | ||
| | B | Bernabéu | Spain (1982) | `bernabeu` | | ||
| | C | Centenario | Uruguay (1930) | `centenario` | | ||
| | D | Düsseldorf (Merkur Spiel-Arena) | Germany (2006) | `dusseldorf` | | ||
| | E | Ekaterinburg Arena | Russia (2018) | `ekaterinburg` | | ||
| | F | Frankfurt Waldstadion | Germany (1974, 2006) | `frankfurt` | | ||
| | G | Gelsenkirchen | Germany (2006) | `gelsenkirchen` | | ||
| | H | Hard Rock Stadium | USA (2026) | `hardrock` | | ||
| | I | Ibn Batouta Stadium | Morocco (2030) | `ibnbatouta` | | ||
| | J | Johannesburg Soccer City | South Africa (2010) | `johannesburg` | | ||
| | K | Kazan Arena | Russia (2018) | `kazan` | | ||
| | L | Lusail | Qatar (2022) | `lusail` | | ||
| | M | Maracanã | Brazil (1950, 2014) | `maracana` | | ||
| | N | Nantes Beaujoire | France (1998) | `nantes` | | ||
| | O | Olympiastadion Berlin | Germany (1974, 2006) | `olympiastadion` | | ||
| | P | Parc des Princes | France (1938, 1998) | `parcdesprinces` | | ||
| | Q | Qatar 974 | Qatar (2022) | `qatar974` | | ||
| | R | Rose Bowl | USA (1994) | `rosebowl` | | ||
| | S | San Siro | Italy (1934, 1990) | `sansiro` | | ||
| | T | Toronto BMO Field | Canada (2026) | `toronto` | | ||
| | U | Ullevi | Sweden (1958) | `ullevi` | | ||
| | V | Volgograd Arena | Russia (2018) | `volgograd` | | ||
| | W | Wembley | England (1966) | `wembley` | | ||
| | X | Xiamen Egret Stadium | (famous fallback) | `xiamen` | | ||
| | Y | Yokohama International Stadium | Japan (2002) | `yokohama` | | ||
| | Z | Zentralstadion Leipzig | Germany (1974, 2006) | `zentralstadion` | | ||
|
|
||
| --- | ||
|
|
||
| ## [Unreleased] | ||
|
|
||
| ### Added | ||
|
|
||
| ### Changed | ||
|
|
||
| ### Fixed | ||
|
|
||
| ### Removed | ||
|
|
||
| --- | ||
|
|
||
| ## How to Release | ||
|
|
||
| To create a new release: | ||
|
|
||
| 1. Update this CHANGELOG with release notes under the appropriate version heading | ||
| 2. Create and push a version tag with stadium name: | ||
|
|
||
| ```bash | ||
| git tag -a v1.0.0-azteca -m "Release 1.0.0 - Azteca" | ||
| git push origin v1.0.0-azteca | ||
| ``` | ||
|
|
||
| 3. The CD workflow will automatically: | ||
| - Build and test the project | ||
| - Publish Docker images to GHCR with three tags (`:1.0.0`, `:azteca`, `:latest`) | ||
| - Create a GitHub Release with auto-generated notes | ||
|
|
||
| --- | ||
|
|
||
| <!-- Template for new releases: | ||
|
|
||
| ## [X.Y.Z - STADIUM_NAME] - YYYY-MM-DD | ||
|
|
||
| ### Added | ||
| - New features | ||
|
|
||
| ### Changed | ||
| - Changes in existing functionality | ||
|
|
||
| ### Fixed | ||
| - Bug fixes | ||
|
|
||
| ### Removed | ||
| - Removed features | ||
|
|
||
| --> |
This file contains hidden or 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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.