Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Michael Henderson committed Jul 10, 2024
1 parent f475ee5 commit ab1324a
Showing 1 changed file with 12 additions and 14 deletions.
26 changes: 12 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,13 @@
### 👨🏿‍🚀 Actions v3 Workflows

#### The v3 Actions make use of doctool.
### What's new in v3
* The v3 Actions make use of [doctool](https://github.com/Keyfactor/doctool)
* Polaris SAST/SCA scans run on push to release and main branches
* All actions are being migrated to forks in the keyfactor org for security hardening purposes. AB#55122
* Access to 3rd party actions will be restrcited in the keyfactor org
* The keyfactor-action-staging organization can be used for developing workflows that will need to be transferred to the keyfactor org before making it public

These workflows are designed to work with the latest [keyfactor-bootstrap-workflow.yml "Keyfactor Bootstrap Workflow"](https://github.com/Keyfactor/.github/blob/main/workflow-templates/keyfactor-bootstrap-workflow.yml)
This *bootstrap workflow* passes 2 secrets to the starter.yml workflow. If you are testing or developing from a forked copy of this repository, but sure to set the secrets:

* V2BUILDTOKEN: This is required for all builds and must have full repo scope, and package:read permissions
* APPROVE_README_PUSH: full repo scope

The following are used for go lang builds and are set at the organization level. If you test or develop for a fork, you will need to add secrets to our local forked repository with the following definitions:
* gpg_key: This is a private gpg key stored as a secret
* gpg_pass: This is th private gpg passphrase stored as a secret
These workflows are designed to work with the latest [keyfactor-bootstrap-workflow.yml "Keyfactor Bootstrap v3 Workflow"](https://github.com/Keyfactor/.github/blob/main/workflow-templates/keyfactor-bootstrap-workflow-v3.yml)

### 🚀The Bootstrap workflow for v3 Actions perform the following steps:

Expand All @@ -20,20 +17,21 @@ The following are used for go lang builds and are set at the organization level.
* Determine event_name: create, push, pull_request, workflow_dispatch [***github-release]***
* Run the workflows and conditionalized steps to produce a build. If conditions match, release artifacts are delivered [***dotnet-build-and-release | go-build-and-release***]

### On Create:
#### On Create:
* Configure repository settings - This will use the properties from the json to update topic and description, and will set the teams permissions on the repo accordingly. If the ref created is a branch that matches "release-\*.\*", branch protection is added, autlink reference set ab# to devops [***kf-configure-repo***]

### On push or workflow_dispatch:
#### On push or workflow_dispatch:
* Just run the build on the branch with the commit without producing release artifacts
* * C#: run the dotnet-build-and-release.yml workflow
* * Go builds: run the go-build-and-release.yml workflow (still in progress)
* All languages: Generate a readme and (conditionally) a catalog entry [***generate-readme, update-catalog***]
* All languages: Generate a readme using doctool and (conditionally) a catalog entry [***generate-readme, update-catalog***]

### On pull_request[opened, closed, synchronize, edited, reopened]:
#### On pull_request[opened, closed, synchronize, edited, reopened]:
[***dotnet-build-and-release | go-build-and-release***]
* If the pr destination is a release-*.* branch, set flags to produce release artifacts
* If the pr is determined to be open or merged but not closed (synchronize), a prerelease artifact will be uploaded
* If the pr is determined to be merged and closed, a final release is built
* Polaris SAST/SCAN scans run when push to release-* or main occurs



Expand Down

0 comments on commit ab1324a

Please sign in to comment.