Publishing preview packages daily (Lombiq Technologies: OCORE-151)

.github/workflows/main_ci.yml

@@ -0,0 +1,47 @@
+name: Main - CI
+on:
+  push:
+    paths-ignore:
+      - '**/*.md'
+      - 'mkdocs.yml'
+      - 'src/docs/**/*'
+    branches: [ main ]
+env:
+  DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true
+  DOTNET_CLI_TELEMETRY_OPTOUT: true
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    name: Build & Test
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+    steps:
+    - uses: actions/checkout@v3
+    - uses: actions/setup-node@v3
+      with:
+        node-version: "15"
+    - uses: actions/setup-dotnet@v3
+      with:
+        dotnet-version: '8.0.x'
+    - name: Build
+      run: |
+        dotnet build -c Release
+    - name: Unit Tests
+      run: |
+        dotnet test -c Release --no-build ./test/OrchardCore.Tests/OrchardCore.Tests.csproj 
+    - name: Functional Tests
+      if: matrix.os == 'ubuntu-latest'
+      run: |
+        cd test/OrchardCore.Tests.Functional
+        npm install
+        npm run cms:test
+        npm run mvc:test
+    - uses: actions/upload-artifact@v2
+      if: matrix.os == 'ubuntu-latest' && failure()
+      with:
+        name: Functional Test failure
+        path: |
+          test/OrchardCore.Tests.Functional/cms-tests/cypress/screenshots
+          src/OrchardCore.Cms.Web/App_Data_Tests/logs

.github/workflows/preview_ci.yml

@@ -1,69 +1,75 @@
 name: Preview - CI
 on:
-  push:
-    paths-ignore:
-      - '**/*.md'
-      - 'mkdocs.yml'
-      - 'src/docs/**/*'
-    branches: [ main ]
+  workflow_dispatch:
+  schedule:
+    # 4:19 AM UTC every day. A random time to avoid peak times of GitHub Actions.
+    - cron: '19 4 * * *'
 env:
   DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true
   DOTNET_CLI_TELEMETRY_OPTOUT: true
 jobs:
   test:
-    runs-on: ${{ matrix.os }}
+    runs-on: ubuntu-latest
     name: Build, Test, Deploy
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [ubuntu-latest, windows-latest]
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
+    - name: Check if should publish
+      id: check-publish
+      shell: pwsh
+      run: |
+        $hasCommitFromLastDay = ![string]::IsNullOrEmpty((git log --oneline --since '24 hours ago'))
+        Write-Output "Commits found in the last 24 hours: $hasCommitFromLastDay."
+        $shouldPublish = $hasCommitFromLastDay -and '${{ github.event_name }}' -eq 'schedule'
+        "should-publish=$($shouldPublish ? 'true' : 'false')" >> $Env:GITHUB_OUTPUT
     - uses: actions/setup-node@v3
+      if: steps.check-publish.outputs.should-publish == 'true'
       with:
         node-version: "15"
     - uses: actions/setup-dotnet@v3
+      if: steps.check-publish.outputs.should-publish == 'true'
       with:
         dotnet-version: '8.0.x'
-    - name: Set build number 
-      if: matrix.os == 'ubuntu-latest'
+    - name: Set build number
+      if: steps.check-publish.outputs.should-publish == 'true'
       run: echo "BuildNumber=$(( $GITHUB_RUN_NUMBER + 16368 ))" >> $GITHUB_ENV
     - name: Build
+      if: steps.check-publish.outputs.should-publish == 'true'
       run: |
         dotnet build -c Release
     - name: Unit Tests
+      if: steps.check-publish.outputs.should-publish == 'true'
       run: |
         dotnet test -c Release --no-build ./test/OrchardCore.Tests/OrchardCore.Tests.csproj 
     - name: Functional Tests
-      if: matrix.os == 'ubuntu-latest'
+      if: steps.check-publish.outputs.should-publish == 'true'
       run: |
         cd test/OrchardCore.Tests.Functional
         npm install
         npm run cms:test
         npm run mvc:test
     - uses: actions/upload-artifact@v2
-      if: matrix.os == 'ubuntu-latest' && failure()
+      if: failure()
       with:
         name: Functional Test failure
         path: |
           test/OrchardCore.Tests.Functional/cms-tests/cypress/screenshots
           src/OrchardCore.Cms.Web/App_Data_Tests/logs
-    - name: Deploy preview nuget packages
-      if: matrix.os == 'ubuntu-latest'
+    - name: Deploy preview NuGet packages
+      if: steps.check-publish.outputs.should-publish == 'true'
       run: |
         dotnet pack -c Release --no-build
         dotnet nuget push './src/**/*.nupkg' -t 600 -k ${{secrets.CLOUDSMITH_API_KEY}} -n -s https://nuget.cloudsmith.io/orchardcore/preview/v3/index.json --skip-duplicate
     - name: Set up Docker Buildx
-      if: matrix.os == 'ubuntu-latest'
+      if: steps.check-publish.outputs.should-publish == 'true'
       uses: docker/setup-buildx-action@v3
     - name: Login to DockerHub
-      if: matrix.os == 'ubuntu-latest'
+      if: steps.check-publish.outputs.should-publish == 'true'
       uses: docker/login-action@v3
       with:
         username: ${{ secrets.DOCKERHUB_USERNAME }}
         password: ${{ secrets.DOCKERHUB_PASSWORD }}
-    - name: Deploy preview docker images
-      if: matrix.os == 'ubuntu-latest'
+    - name: Deploy preview Docker images
+      if: steps.check-publish.outputs.should-publish == 'true'
       shell: pwsh
       run: |
         Get-ChildItem ./src/OrchardCore.Cms.Web/App_Data -Recurse | Remove-Item -Recurse -Confirm:$false

README.md

@@ -12,12 +12,12 @@ Orchard Core consists of two distinct projects:
 
 ## Build Status
 
-Stable (release/1.8.2): 
+Stable (`release/1.8.2`): 
 
 [![Build status](https://github.com/OrchardCMS/OrchardCore/actions/workflows/release_ci.yml/badge.svg)](https://github.com/OrchardCMS/OrchardCore/actions?query=workflow%3A%22Release+-+CI%22)
 [![NuGet](https://img.shields.io/nuget/v/OrchardCore.Application.Cms.Targets.svg)](https://www.nuget.org/packages/OrchardCore.Application.Cms.Targets)
 
-Nightly (main): 
+Nightly (`main`): 
 
 [![Build status](https://github.com/OrchardCMS/OrchardCore/actions/workflows/preview_ci.yml/badge.svg)](https://github.com/OrchardCMS/OrchardCore/actions?query=workflow%3A%22Preview+-+CI%22)
 [![Cloudsmith](https://api-prd.cloudsmith.io/badges/version/orchardcore/preview/nuget/OrchardCore.Application.Cms.Targets/latest/x/?render=true&badge_token=gAAAAABey9hKFD_C-ZIpLvayS3HDsIjIorQluDs53KjIdlxoDz6Ntt1TzvMNJp7a_UWvQbsfN5nS7_0IbxCyqHZsjhmZP6cBkKforo-NqwrH5-E6QCrJ3D8%3D)](https://cloudsmith.io/~orchardcore/repos/preview/packages/detail/nuget/OrchardCore.Application.Cms.Targets/latest/)

src/docs/getting-started/preview-package-source.md

@@ -1,11 +1,11 @@
 # Add preview package source
 
-In this article, we are going to add a new package source pointing to the preview packages.  
-The preview packages are built each time some code is committed on the `dev` branch, compared to the ones on NuGet, built from the `master` branch.  
-They are the most up to date versions but not the most stable and can contain breaking changes.
+In this article, we are going to add a new package source pointing to the preview packages. The preview packages are built every day from the latest code on the `main` branch and published to [Cloudsmith](https://cloudsmith.io/~orchardcore/repos/preview/packages/). Release packages are published to NuGet, built from code corresponding to that release's version tag.
+
+The preview packages are the most up-to-date versions but not the most stable and can contain breaking changes. Only use them if you want to work with the latest development version of Orchard Core, e.g. to try out a fix for a bug you reported.
 
 !!! warning
-    We do not suggest you to use the dev packages in production.
+    We do not suggest you use the preview packages in production. Preview packages are not kept forever, and there's no guarantee on how long a given preview package will be available. (You can assume something like 1-1.5 months, but then again, there's no guarantee.)
 
 ## Adding Orchard Core preview Feed to Visual Studio