Skip to content

Latest commit

 

History

History
23 lines (16 loc) · 2.17 KB

README.md

File metadata and controls

23 lines (16 loc) · 2.17 KB
Raw

GitHub Action templates to support Keyfactor Integration Catalog and Release processes. Note that while this repository is publicly visible, its contents are intended for Keyfactor internal use.

Release Actions

The release workflow will checkout, setup, and build the Keyfactor extension automatically when a branch matching the release-[0-9]+.[0-9]+ pattern. The branch name is used to label the release in Github and determine the Major and Minor version. The release and source will be tagged automatically and the bump determined by the branch name's version e.g. release-1.2 will build Major.Minor version 1.2. The Patch and pre-release version numbers will be auto-incremented as additional builds happen from that branch.

Addtionally, the workflow will automatically apply the generated tag version number to the .net assemblies prior to the build. This ensures the tagged version number matches the file version. If any step fails, the workflow will remove any release/tags created as part of the process.

Adding the Release Action to your Repo

All workflow YAML files must be located in the .github/workflows directory of your repository. A file can be created manually and pushed to the repo or a new file copied from the Keyfactor template in the Actions > New Workflow menu option

Most of the template is ready to use and will dynamically find the solution file, the release name(from branch name), and the repository name used to artifacts. However, due to the variability in project structures and dependencies a few manual modifications will be required.

TODO when adding a build template

  • Enter <SOLUTION_FOLDER_NAME> and <PROJECT_FOLDER_NAME> values
    • Create additional project variables if relevant e.g. <PROJECT_FOLDER_NAME_1> and <PROJECT_FOLDER_NAME_2>
  • Change Compress-Archive command in the Archive Files step to match the expected release output
    • Include necessary build output like DLLs and config files
    • Enumerate PROJECT_FOLDERs if there are multiple output locations to check

Assumptions

  • CHANGELOG.md must be located in the root of the repository. The release process will create a link to this file from the release to document changes/release notes.