Skip to content

Commit fb01e2b

Browse files
spbsolublespbsoluble
committed
fix(polaris): Comment out polaris until integration can be fixed.
1 parent d81a3b0 commit fb01e2b

File tree

3 files changed

+132
-112
lines changed

3 files changed

+132
-112
lines changed

‎.github/workflows/starter.yml‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -156,13 +156,13 @@ jobs:
156156
secrets:
157157
token: ${{ secrets.token }}
158158

159-
call-polaris-scan-workflow:
160-
if: github.event_name == 'pull_request' && (startsWith(github.base_ref, 'release-') || github.base_ref == 'main')
161-
uses: Keyfactor/actions/.github/workflows/kf-polaris-scan.yml@v4
162-
with:
163-
scan_branch: ${{ github.event.pull_request.head.ref }}
164-
secrets:
165-
token: ${{ secrets.scan_token }}
159+
# call-polaris-scan-workflow:
160+
# if: github.event_name == 'pull_request' && (startsWith(github.base_ref, 'release-') || github.base_ref == 'main')
161+
# uses: Keyfactor/actions/.github/workflows/kf-polaris-scan.yml@v4
162+
# with:
163+
# scan_branch: ${{ github.event.pull_request.head.ref }}
164+
# secrets:
165+
# token: ${{ secrets.scan_token }}
166166

167167
call-post-release-workflow:
168168
needs: [ call-assign-from-json-workflow, call-create-github-release-workflow ]

‎CHANGELOG.md‎

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,3 @@
1-
# [3.4.0](https://github.com/Keyfactor/actions/compare/3.3.1...3.4.0) (2025-09-11)
2-
3-
4-
### Bug Fixes
5-
6-
* **starter:** `entra_username` not required ([e8ef978](https://github.com/Keyfactor/actions/commit/e8ef978040b927afe117590e13034ed37c7aa7a4))
7-
* **starter:** Call out `write` permissions on generate-readme ([578161c](https://github.com/Keyfactor/actions/commit/578161ce9288a0b2047854dd499b96996ee75bb6))
8-
* **starter:** Remove container and maven workflow refs. ([86dfcf4](https://github.com/Keyfactor/actions/commit/86dfcf41593fbc3562baea46d6590079f328559f))
9-
* **starter:** Remove unused `APPROVE_README_PUSH` input ([a92ee10](https://github.com/Keyfactor/actions/commit/a92ee10e2cd901ddb6cd32e1b161dbc16d58ed3b))
10-
* **starter:** Update self refs for generate-readme ([5858ee9](https://github.com/Keyfactor/actions/commit/5858ee9f1653ec153ad3297d21cdc9aa5b4d42e5))
11-
* **starter:** Update self version references from `v3` to `v4` ([79bd7a4](https://github.com/Keyfactor/actions/commit/79bd7a4ba43e3a8a94552872e51174402c2bd8b2))
12-
13-
14-
### Features
15-
16-
* **docs:** add screenshot automation workflow inputs ([1b0642e](https://github.com/Keyfactor/actions/commit/1b0642ecfd727714bd3caf34da5ee47c73f4d5a4))
17-
181
## [3.3.1](https://github.com/Keyfactor/actions/compare/3.3.0...3.3.1) (2025-06-23)
192

203

‎README.md‎

Lines changed: 125 additions & 88 deletions
Original file line numberDiff line numberDiff line change
@@ -1,92 +1,98 @@
1-
### 👨🏿‍🚀 Actions v4 Workflows
1+
### 👨🏿‍🚀 Actions v4 Workflows
22

33
### What's new in v4
4-
* The v4 Actions make use of [doctool](https://github.com/Keyfactor/doctool) to take Command screenshots for Universal Orchestrator extension store-type creation.
4+
5+
* The v4 Actions make use of [doctool](https://github.com/Keyfactor/doctool) to take Command screenshots for Universal
6+
Orchestrator extension store-type creation.
57

68
### Usage
79

810
#### Prerequisites
9-
- Ensure an `integration-manifest.json` file is present in the root of your repository. For the schema, see the v2 [integration-manifest-schema.json](https://keyfactor.github.io/v2/integration-manifest-schema.json)
11+
12+
- Ensure an `integration-manifest.json` file is present in the root of your repository. For the schema, see the
13+
v2 [integration-manifest-schema.json](https://keyfactor.github.io/v2/integration-manifest-schema.json)
1014

1115
#### Example `integration-manifest.json`
16+
1217
```json
1318
{
14-
"$schema": "https://keyfactor.github.io/v2/integration-manifest-schema.json",
15-
"integration_type": "anyca-plugin",
16-
"name": "Example AnyCA REST Gateway Plugin",
17-
"status": "pilot",
18-
"support_level": "kf-supported",
19-
"link_github": true,
20-
"update_catalog": true,
21-
"description": "Example Plugin for the AnyCA REST Gateway framework",
22-
"gateway_framework": "25.0.0",
23-
"release_dir": "example-caplugin\\bin\\Release",
24-
"release_project": "example-caplugin\\example_extension.csproj",
25-
"about": {
26-
"carest": {
27-
"ca_plugin_config": [
28-
{
29-
"name": "ApiKey",
30-
"description": "The API Key for the The CA API"
31-
},
32-
{
33-
"name": "Username",
34-
"description": "Username for the CA API service account"
35-
},
36-
{
37-
"name": "Password",
38-
"description": "Password for the CA API service account"
39-
},
40-
{
41-
"name": "BaseUrl",
42-
"description": "The Base URL for the CA API"
43-
},
44-
{
45-
"name": "Enabled",
46-
"description": "Flag to Enable or Disable gateway functionality. Disabling is primarily used to allow creation of the CA prior to configuration information being available."
47-
}
48-
],
49-
"enrollment_config": [
50-
{
51-
"name": "CertificateValidityInYears",
52-
"description": "Number of years the certificate will be valid for"
53-
},
54-
{
55-
"name": "Email",
56-
"description": "Email address of the requestor"
57-
},
58-
{
59-
"name": "OrganizationName",
60-
"description": "Name of the organization to be validated against"
61-
}
62-
],
63-
"product_ids": [
64-
"ExampleProductSslOvBasic",
65-
"ExampleProductSslEvBasic",
66-
"ExampleProductSslDvGeotrust",
67-
"ExampleProductSslDvThawte",
68-
"ExampleProductSslOvThawteWebserver",
69-
"ExampleProductSslEvThawteWebserver",
70-
"ExampleProductSslOvGeotrustTruebizid",
71-
"ExampleProductSslEvGeotrustTruebizid",
72-
"ExampleProductSslOvSecuresite",
73-
"ExampleProductSslEvSecuresite",
74-
"ExampleProductSslOvSecuresitePro",
75-
"ExampleProductSslEvSecuresitePro"
76-
]
77-
}
19+
"$schema": "https://keyfactor.github.io/v2/integration-manifest-schema.json",
20+
"integration_type": "anyca-plugin",
21+
"name": "Example AnyCA REST Gateway Plugin",
22+
"status": "pilot",
23+
"support_level": "kf-supported",
24+
"link_github": true,
25+
"update_catalog": true,
26+
"description": "Example Plugin for the AnyCA REST Gateway framework",
27+
"gateway_framework": "25.0.0",
28+
"release_dir": "example-caplugin\\bin\\Release",
29+
"release_project": "example-caplugin\\example_extension.csproj",
30+
"about": {
31+
"carest": {
32+
"ca_plugin_config": [
33+
{
34+
"name": "ApiKey",
35+
"description": "The API Key for the The CA API"
36+
},
37+
{
38+
"name": "Username",
39+
"description": "Username for the CA API service account"
40+
},
41+
{
42+
"name": "Password",
43+
"description": "Password for the CA API service account"
44+
},
45+
{
46+
"name": "BaseUrl",
47+
"description": "The Base URL for the CA API"
48+
},
49+
{
50+
"name": "Enabled",
51+
"description": "Flag to Enable or Disable gateway functionality. Disabling is primarily used to allow creation of the CA prior to configuration information being available."
52+
}
53+
],
54+
"enrollment_config": [
55+
{
56+
"name": "CertificateValidityInYears",
57+
"description": "Number of years the certificate will be valid for"
58+
},
59+
{
60+
"name": "Email",
61+
"description": "Email address of the requestor"
62+
},
63+
{
64+
"name": "OrganizationName",
65+
"description": "Name of the organization to be validated against"
66+
}
67+
],
68+
"product_ids": [
69+
"ExampleProductSslOvBasic",
70+
"ExampleProductSslEvBasic",
71+
"ExampleProductSslDvGeotrust",
72+
"ExampleProductSslDvThawte",
73+
"ExampleProductSslOvThawteWebserver",
74+
"ExampleProductSslEvThawteWebserver",
75+
"ExampleProductSslOvGeotrustTruebizid",
76+
"ExampleProductSslEvGeotrustTruebizid",
77+
"ExampleProductSslOvSecuresite",
78+
"ExampleProductSslEvSecuresite",
79+
"ExampleProductSslOvSecuresitePro",
80+
"ExampleProductSslEvSecuresitePro"
81+
]
7882
}
83+
}
7984
}
8085
```
8186

8287
#### Example workflow `keyfactor-bootsrap-workflow.yml`
88+
8389
```yaml
8490
name: Keyfactor Bootstrap Workflow
8591

8692
on:
8793
workflow_dispatch:
8894
pull_request:
89-
types: [opened, closed, synchronize, edited, reopened]
95+
types: [ opened, closed, synchronize, edited, reopened ]
9096
push:
9197
create:
9298
branches:
@@ -108,44 +114,75 @@ jobs:
108114
entra_password: ${{ secrets.DOCTOOL_ENTRA_PASSWD }} # Only required for doctool generated screenshots
109115
command_client_id: ${{ secrets.COMMAND_CLIENT_ID }} # Only required for doctool generated screenshots
110116
command_client_secret: ${{ secrets.COMMAND_CLIENT_SECRET }} # Only required for doctool generated screenshots
117+
111118
```
112119

113-
### 🚀The Bootstrap workflow for v4 Actions perform the following steps:
120+
#### Inputs
121+
122+
| Parameter | Type | Description | Required/Optional |
123+
|-----------------------|--------|----------------------------------------------------------------|--------------------------------|
124+
| command_token_url | Input | URL for command token, used by doctool for screenshots | Optional (doctool screenshots) |
125+
| command_hostname | Input | Hostname for command, used by doctool for screenshots | Optional (doctool screenshots) |
126+
| command_base_api_path | Input | Base API path for command, used by doctool for screenshots | Optional (doctool screenshots) |
127+
| token | Secret | Build token for workflow execution | Required |
128+
| gpg_key | Secret | GPG private key for signing golang builds | Optional (golang builds) |
129+
| gpg_pass | Secret | GPG passphrase for signing golang builds | Optional (golang builds) |
130+
| scan_token | Secret | Token for SAST/Polaris scan | Required |
131+
| entra_username | Secret | Username for doctool Entra authentication (screenshots) | Optional (doctool screenshots) |
132+
| entra_password | Secret | Password for doctool Entra authentication (screenshots) | Optional (doctool screenshots) |
133+
| command_client_id | Secret | Client ID for command API, used by doctool for screenshots | Optional (doctool screenshots) |
134+
| command_client_secret | Secret | Client secret for command API, used by doctool for screenshots | Optional (doctool screenshots) |
135+
136+
### 🚀The Bootstrap workflow for v4 Actions perform the following steps:
114137

115138
* Checkout integration repository
116139
* Call [starter.yml](.github/workflows/starter.yml) workflow
117140
* Get values from integration-manifest.json [assign-env-from-json](.github/workflows/assign-env-from-json.yml)
118141
* Discover primary programming language from the repository [***action-get-primary-language***]
119-
* Determine event_name: `create, push, pull_request, workflow_dispatch` [github-release.yml](.github/workflows/github-release.yml)
120-
* Run the workflows and conditionalized steps to produce a build. If conditions match, release artifacts are delivered
121-
[dotnet-build-and-release.yml](.github/workflows/dotnet-build-and-release.yml) or [go-build-and-release.yml](.github/workflows/go-build-and-release.yml)
122-
workflow will be run depending on the `detected-primary-language` step in [starter.yml](.github/workflows/starter.yml)
142+
* Determine event_name:
143+
`create, push, pull_request, workflow_dispatch` [github-release.yml](.github/workflows/github-release.yml)
144+
* Run the workflows and conditionalized steps to produce a build. If conditions match, release artifacts are delivered
145+
[dotnet-build-and-release.yml](.github/workflows/dotnet-build-and-release.yml)
146+
or [go-build-and-release.yml](.github/workflows/go-build-and-release.yml)
147+
workflow will be run depending on the `detected-primary-language` step in [starter.yml](.github/workflows/starter.yml)
123148

124149
#### On Create:
125-
* 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***]
150+
151+
* Configure repository settings - This will use the properties from the json to update topic and description, and will
152+
set the teams permissions on the repo accordingly. If the ref created is a branch that matches "release-\*.\*", branch
153+
protection is added, autlink reference set ab# to devops [***kf-configure-repo***]
126154

127155
#### On push or workflow_dispatch:
156+
128157
* Just run the build on the branch with the commit without producing release artifacts
129-
* * C#: run the [dotnet-build-and-release.yml](.github/workflows/dotnet-build-and-release.yml) workflow
130-
* * Go builds: run the go-build-and-release.yml workflow (still in progress)
131-
* All languages:
132-
* * Generate/Update `README.md` using `doctool` [generate-readme.yml](.github/workflows/generate-readme.yml)
133-
* * (conditionally) a catalog entry [update-catalog](.github/workflows/update-catalog.yml) will be created/updated if the json manifest has `"update_catalog": true` in the `integration-manifest.json` file
158+
*
159+
* C#: run the [dotnet-build-and-release.yml](.github/workflows/dotnet-build-and-release.yml) workflow
160+
*
161+
* Go builds: run the go-build-and-release.yml workflow (still in progress)
162+
* All languages:
163+
*
164+
* Generate/Update `README.md` using `doctool` [generate-readme.yml](.github/workflows/generate-readme.yml)
165+
*
166+
* (conditionally) a catalog entry [update-catalog](.github/workflows/update-catalog.yml) will be created/updated if
167+
the json manifest has `"update_catalog": true` in the `integration-manifest.json` file
134168

135169
#### On pull_request[opened, closed, synchronize, edited, reopened]:
136-
[dotnet-build-and-release.yml](.github/workflows/dotnet-build-and-release.yml) workflow or [go-build-and-release.yml](.github/workflows/go-build-and-release.yml) workflow will be run depending on the detected primary language
137-
* If the pr destination is a `release-*.*` branch, set flags to produce release artifacts
138-
* If the pr is determined to be `open` or `merged` but not `closed` (synchronize), a prerelease artifact will be uploaded
139-
* If the pr is determined to be `merged` and `closed`, a final "official" release is built and published to GitHub releases, and if `"update_catalog": true` is set in the json manifest, a catalog entry will be created/updated
140-
* Polaris SAST/SCAN scans run when push to `release-*` or main occurs
141-
* If PR to release branch is `merged/closed`, a new PR will be automatically generated. This will need to be approved manually and **should not** be approved for hotfix branches
142-
143-
144170

171+
[dotnet-build-and-release.yml](.github/workflows/dotnet-build-and-release.yml) workflow
172+
or [go-build-and-release.yml](.github/workflows/go-build-and-release.yml) workflow will be run depending on the detected
173+
primary language
145174

175+
* If the pr destination is a `release-*.*` branch, set flags to produce release artifacts
176+
* If the pr is determined to be `open` or `merged` but not `closed` (synchronize), a prerelease artifact will be
177+
uploaded
178+
* If the pr is determined to be `merged` and `closed`, a final "official" release is built and published to GitHub
179+
releases, and if `"update_catalog": true` is set in the json manifest, a catalog entry will be created/updated
180+
* Polaris SAST/SCAN scans run when push to `release-*` or main occurs
181+
* If PR to release branch is `merged/closed`, a new PR will be automatically generated. This will need to be approved
182+
manually and **should not** be approved for hotfix branches
146183

184+
### 📝Todo:
147185

148-
### 📝Todo:
149186
* Remove default admin user when applying branch protection
150187
* Add overrides for detected language, readme build(?), etc. into json manifest
151188
* Set repo license

0 commit comments

Comments
 (0)