Skip to content

Latest commit

 

History

History
74 lines (47 loc) · 6.43 KB

Readme.md

File metadata and controls

74 lines (47 loc) · 6.43 KB
Raw

Lombiq GitHub Actions

About

Reusable workflows and actions for GitHub Actions shared between Lombiq projects, for example:

  • Build and test Orchard Core apps
  • Build and test .NET Framework and .NET Core applications in general
  • Publish packages to NuGet
  • Verify and validate pull requests
  • Check spelling
  • Perform static code analysis and linting
  • Deploy to an Azure App Service, swap staging and production slots, and copy production data to the staging site
  • And more!

These can be invoked from any other repository's build.

Check out a demo on our YouTube channel, and the Orchard Harvest 2023 conference talk about automated QA in Orchard Core here.

We at Lombiq also used these workflows for the following projects:

Documentation

Note

The code samples in the documentation reference the latest versions of the workflows and actions from the dev branch with @dev. This allows you to always use the latest versions, and get updates immediately. If instead you prefer stability, reference a specific version instead, like @1.2.0. You can see the versions available under Releases.

Contributing and support

Bug reports, feature requests, comments, questions, code contributions and love letters are warmly welcome. You can send them to us via GitHub issues and pull requests. Please adhere to our open-source guidelines while doing so.

This project is developed by Lombiq Technologies. Commercial-grade support is available through Lombiq.

Default .NET version

For .NET workflows, the default .NET SDK version we should provide is a concrete patch version of the latest .NET version, the most recent one at the time of updating .NET support (e.g., to 8.0.301 when .NET 8 is the latest). We need to pin the .NET SDK to a specific version like this to avoid unexpected build changes that patch version updates bring (which happens if the version is specified as e.g. 8.0.x). See this issue for more context.

We can still choose to update to a more recent patch version, but only deliberately.

Reference validation

To ensure that when changing actions or workflows their references to other actions/workflows are up-to-date (i.e. instead of @dev they reference each other with @current-branch) the Validate GitHub Actions Refs workflow will fail if references are incorrect. This is the case also if after a pull request approve that references don't point to the target branch; before merging, that should be fixed, otherwise merging via the merge queue will fail.

Versioning, Tags and Releases

To release versions of Lombiq GitHub Actions, and allow consumers to reference a specific version of a reusable workflow or composite action (e.g. @v1.0.0), we employ some automation to do this in a consistent and predictable way.

See issue #284 "Introduce versioning and releases (OSOE-735)" for additional details on why we do this.

New versions of Lombiq GitHub Actions are automatically tagged using the Tag Version (this repo) workflow. This workflow is triggered for release branches with a name that matches the release/** pattern (e.g. release/v1.0.0, release/v2.1.0-alpha, etc.).

To create a new release, create a new branch following the above naming convention at the commit to be released and push it. This is similar to how you would add a release tag in other repos, and don't push anything else to the release branch.

When you push your new release branch, the following things happen automatically:

  1. The Tag Version (this repo) workflow runs and calls the reusable workflow Tag Version.
  2. The Tag Version workflow calls the Set GitHub Actions References reusable action.
  3. The Set GitHub Actions References action recursively searches all files in the .github folder to find each call to a GitHub Action or Workflow contained in this repository.
  4. By default, references to called actions and workflows targeting the release branch (see above) are string replaced with the version name (e.g. v1.0).
  5. The stefanzweifel/git-auto-commit-action action is used to automatically:
    • Commit the updated files to the release/v1.0 branch.
    • Create a new git tag using the release name (e.g. v1.0).
  6. Tags are force pushed to update the v1.0 tag if it needs to be updated.