Public release

Author: jenkins-cfrd

LICENSE

@@ -1,11 +1,26 @@
-© Copyright 2023 Micro Focus or one of its affiliates.
+Copyright 2016-2023 Open Text.
+
+The only warranties for products and services of Open Text and
+its affiliates and licensors (“Open Text”) are as may be set forth
+in the express warranty statements accompanying such products and services.
+Nothing herein should be construed as constituting an additional warranty.
+Open Text shall not be liable for technical or editorial errors or
+omissions contained herein. The information contained herein is subject
+to change without notice.
+
+Except as specifically indicated otherwise, this document contains
+confidential information and a valid license is required for possession,
+use or copying. If this work is provided to the U.S. Government,
+consistent with FAR 12.211 and 12.212, Commercial Computer Software,
+Computer Software Documentation, and Technical Data for Commercial Items are
+licensed to the U.S. Government under vendor's standard commercial license.
+
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at
   http://www.apache.org/licenses/LICENSE-2.0
-
 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
-limitations under the License.
+limitations under the License.

README.md

@@ -6,12 +6,13 @@ Custom GitHub action which facilitates communication between GitHub and ALM Octa
  [Workflow Configuration](#Workflow-Configuration)
 
  [Change log](#Change-log)
+- [v23.3.0](#v2330)
 - [v1.0](#v10)
 
 ## Requirements
-- At least one GitHub runner alocated for running the integration.
+- At least one GitHub runner allocated for running the integration.
 - ALM Octane version 16.1.200 or higher
-- ALM Octane API Acess with CI/CD Integration and DevOps Admin roles.
+- ALM Octane API Access with CI/CD Integration and DevOps Admin roles.
 
 ## Workflow Configuration
 ### Note: these steps should be done inside your GitHub repository.
@@ -38,6 +39,7 @@ env:
 secret variables configuration [here](https://docs.github.com/en/actions/security-guides/encrypted-secrets)).
 - Set integration config params (ALM Octane URL, Shared Space, Workspace, credentials) and repository (Token and URL).
 - Set unitTestResultsGlobPattern to match desired Test Results path.
+- For Private repositories go to ```Settings -> Actions -> General``` and set your GITHUB_TOKEN permissions to Read and write. This is necessary to access the actions scope. (more details about GITHUB_TOKEN permissions [here](https://docs.github.com/en/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token))
 
 ```yaml
 jobs:
@@ -104,13 +106,16 @@ jobs:
 
 ## Limitations
 - Needs at least one dedicated GitHub runner to execute the integration workflow.
-- On each pipeline run, the commits that happened since the previous ALM Octane build will be injected. For that, at least one ALM Octane build needs to exist (the commits will be injected starting from the second run of the pipepline with the integration).
+- On each pipeline run, the commits that happened since the previous ALM Octane build will be injected. For that, at least one ALM Octane build needs to exist (the commits will be injected starting from the second run of the pipeline with the integration).
 - Commits from secondary branches will be injected by running the workflow on the desired branch.
 ## Change log
 
+### v23.3.0
+ - Rebranding.
+ - Fixed issue with logs when connection to ALM Octane was failing.
+ 
 ### v1.0
 - Creates CI server and pipelines, and reflects pipeline run status in ALM Octane.
 - Injects JUnit test results.
 - Injects SCM data (commits and branches).
 - Injects pull requests on GitHub PR events.
-

package.json

@@ -1,6 +1,6 @@
 {
   "name": "alm-octane-github-actions-integration",
-  "version": "1.0.0",
+  "version": "23.3.0",
   "description": "A custom action which facilitates the connection between GitHub actions and ALM Octane.",
   "main": "src/main.ts",
   "scripts": {

resources/octaneConfig.json

@@ -1,9 +1,9 @@
 {
-    "octaneUrl": "https://laura-2.almoctane.com",
-    "octaneSharedSpace": "1001",
-    "octaneWorkspace": "1004",
-    "octaneClientId": "GH_Actions_dp7r14glmojgvupyx23qw15k6",
-    "octaneClientSecret": "(98115591638230150140O",
-    "githubToken": "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",
-    "serverBaseUrl": "https://github-itg.houston.softwaregrp.net/CFRD/testActionsIntegration"
+  "octaneUrl": "",
+  "octaneSharedSpace": ,
+  "octaneWorkspace": ,
+  "octaneClientId": "",
+  "octaneClientSecret": "",
+  "githubToken": "",
+  "serverBaseUrl": ""
 }

resources/workflow_to_run.json

@@ -1 +1,5 @@
-[{"name": "CI_test"}]
+[
+  {
+    "name": ""
+  }
+]

src/client/githubClient.ts

@@ -1,15 +1,30 @@
 /*
-© Copyright 2023 Micro Focus or one of its affiliates.
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-  http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+ * Copyright 2016-2023 Open Text.
+ *
+ * The only warranties for products and services of Open Text and
+ * its affiliates and licensors (“Open Text”) are as may be set forth
+ * in the express warranty statements accompanying such products and services.
+ * Nothing herein should be construed as constituting an additional warranty.
+ * Open Text shall not be liable for technical or editorial errors or
+ * omissions contained herein. The information contained herein is subject
+ * to change without notice.
+ *
+ * Except as specifically indicated otherwise, this document contains
+ * confidential information and a valid license is required for possession,
+ * use or copying. If this work is provided to the U.S. Government,
+ * consistent with FAR 12.211 and 12.212, Commercial Computer Software,
+ * Computer Software Documentation, and Technical Data for Commercial Items are
+ * licensed to the U.S. Government under vendor's standard commercial license.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
 */
 
 import { getOctokit } from '@actions/github';

src/client/octaneClient.ts

@@ -1,15 +1,30 @@
 /*
-© Copyright 2023 Micro Focus or one of its affiliates.
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-  http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+ * Copyright 2016-2023 Open Text.
+ *
+ * The only warranties for products and services of Open Text and
+ * its affiliates and licensors (“Open Text”) are as may be set forth
+ * in the express warranty statements accompanying such products and services.
+ * Nothing herein should be construed as constituting an additional warranty.
+ * Open Text shall not be liable for technical or editorial errors or
+ * omissions contained herein. The information contained herein is subject
+ * to change without notice.
+ *
+ * Except as specifically indicated otherwise, this document contains
+ * confidential information and a valid license is required for possession,
+ * use or copying. If this work is provided to the U.S. Government,
+ * consistent with FAR 12.211 and 12.212, Commercial Computer Software,
+ * Computer Software Documentation, and Technical Data for Commercial Items are
+ * licensed to the U.S. Government under vendor's standard commercial license.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
 */
 
 import { Octane } from '@microfocus/alm-octane-js-rest-sdk';

src/config/config.ts

@@ -1,15 +1,30 @@
 /*
-© Copyright 2023 Micro Focus or one of its affiliates.
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-  http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+ * Copyright 2016-2023 Open Text.
+ *
+ * The only warranties for products and services of Open Text and
+ * its affiliates and licensors (“Open Text”) are as may be set forth
+ * in the express warranty statements accompanying such products and services.
+ * Nothing herein should be construed as constituting an additional warranty.
+ * Open Text shall not be liable for technical or editorial errors or
+ * omissions contained herein. The information contained herein is subject
+ * to change without notice.
+ *
+ * Except as specifically indicated otherwise, this document contains
+ * confidential information and a valid license is required for possession,
+ * use or copying. If this work is provided to the U.S. Government,
+ * consistent with FAR 12.211 and 12.212, Commercial Computer Software,
+ * Computer Software Documentation, and Technical Data for Commercial Items are
+ * licensed to the U.S. Government under vendor's standard commercial license.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
 */
 
 import { getInput } from '@actions/core';

src/dto/github/ActionsEvent.ts

@@ -1,15 +1,30 @@
 /*
-© Copyright 2023 Micro Focus or one of its affiliates.
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-  http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+ * Copyright 2016-2023 Open Text.
+ *
+ * The only warranties for products and services of Open Text and
+ * its affiliates and licensors (“Open Text”) are as may be set forth
+ * in the express warranty statements accompanying such products and services.
+ * Nothing herein should be construed as constituting an additional warranty.
+ * Open Text shall not be liable for technical or editorial errors or
+ * omissions contained herein. The information contained herein is subject
+ * to change without notice.
+ *
+ * Except as specifically indicated otherwise, this document contains
+ * confidential information and a valid license is required for possession,
+ * use or copying. If this work is provided to the U.S. Government,
+ * consistent with FAR 12.211 and 12.212, Commercial Computer Software,
+ * Computer Software Documentation, and Technical Data for Commercial Items are
+ * licensed to the U.S. Government under vendor's standard commercial license.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
 */
 
 import {
@@ -21,20 +36,6 @@ interface GitHubRepository extends PayloadRepository {
   id?: string;
 }
 
-/*
-© Copyright 2023 Micro Focus or one of its affiliates.
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-  http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-*/
-
 export default interface ActionsEvent extends WebhookPayload {
   repository?: GitHubRepository;
   workflow?: {

src/dto/github/ActionsEventType.ts

@@ -1,15 +1,30 @@
 /*
-© Copyright 2023 Micro Focus or one of its affiliates.
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-  http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+ * Copyright 2016-2023 Open Text.
+ *
+ * The only warranties for products and services of Open Text and
+ * its affiliates and licensors (“Open Text”) are as may be set forth
+ * in the express warranty statements accompanying such products and services.
+ * Nothing herein should be construed as constituting an additional warranty.
+ * Open Text shall not be liable for technical or editorial errors or
+ * omissions contained herein. The information contained herein is subject
+ * to change without notice.
+ *
+ * Except as specifically indicated otherwise, this document contains
+ * confidential information and a valid license is required for possession,
+ * use or copying. If this work is provided to the U.S. Government,
+ * consistent with FAR 12.211 and 12.212, Commercial Computer Software,
+ * Computer Software Documentation, and Technical Data for Commercial Items are
+ * licensed to the U.S. Government under vendor's standard commercial license.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
 */
 
 const enum ActionsEventType {