GitHub Actions

GitHub Actions

Relevant GitHub Actions documents

• GitHub Actions Documentation Hub
  • Getting started with GitHub Actions
  • Configuring and managing workflows
  • Language and framework guides
  • Building actions
• Software installed on GitHub-hosted runners
• Using environment variables
• Events that trigger workflows

Current Oryx GitHub Actions

• azure/appservice-build
  • Builds an Azure Web App on Linux using the Oryx build system

Creating a new GitHub Action

• Follow the steps outlined here
  • Create a new private repository through the Open Source portal
  • Verify that the Oryx team has administrator permissions in the new repository
  • Add any missing legal files to the repository
  • Update the README.md to clearly define the action's purpose and provide example end-to-end flows
  • Once the repository has received legal approval from the Open Source team, and the GitHub Action vTeam has approved the repository, move the repository from private to public
  • Publish a release to the GitHub Marketplace (following the steps below for release a new version)

Releasing a new version of a GitHub Action

• Determine the new version of the action based on the changes being made
  • Refer to the action-versioning.md file for more information on versioning a release.
• Create a new branch called vX, vX.Y or vX.Y.Z, depending on the type of version update (major, minor, patch)
• Verify that this new branch has all of the latest changes from the development branch
• Create a new GitHub release with a title and tag that is the same as the branch name
  • Enable the checkbox for **Publish this Action to the GitHub
  • For the Primary Category drop-down menu, choose "Deployment"
  • Ensure that the description of the release includes a list of changes made for the release, as well as the contents of the README.md for reference