Skip to content

Commit 3175386

Browse files
Kem-Govacabarbaye
andauthored
📝 Remove code climate references (#92)
<!-- Copyright (C) 2020-2022 Arm Limited or its affiliates and Contributors. All rights reserved. SPDX-License-Identifier: Proprietary --> ### Description This removes code climate references in files as we have now migrated to Qlty Cloud. _NB: The work to integrate Qlty Cloud changes will be a separate PR as it's dependent on the existence of a repo/organisation level secret for authentication with Qlty._ ### Test Coverage <!-- Please put an `x` in the correct box e.g. `[x]` to indicate the testing coverage of this change. --> - [ ] This change is covered by existing or additional automated tests. - [ ] Manual testing has been performed (and evidence provided) as automated testing was not feasible. - [X] Additional tests are not required for this change (e.g. documentation update). --------- Co-authored-by: Adrien CABARBAYE <[email protected]> Co-authored-by: acabarbaye <[email protected]> Co-authored-by: acabarbaye <[email protected]> Co-authored-by: Kem-Gov <[email protected]> Co-authored-by: Kem-Gov <[email protected]>
1 parent 6986b4b commit 3175386

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+4589
-123
lines changed

.github/workflows/build-and-test.yml

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -77,21 +77,6 @@ jobs:
7777
version: latest
7878
working-directory: ${{ matrix.go-module }}
7979
args: "--verbose --print-issued-lines --print-linter-name --out-${NO_FUTURE}format colored-line-number --timeout 300s --max-issues-per-linter 0 --max-same-issues 0"
80-
# FIXME Send coverage to code climate
81-
#
82-
# - if: ${{ startsWith(matrix.os, 'ubuntu') }}
83-
# name: Test [${{ matrix.go-module }} on ${{ matrix.os }}] & Publish Code Coverage
84-
# uses: paambaati/[email protected]
85-
# env:
86-
# CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
87-
# with:
88-
# debug: true
89-
# workingDirectory: ${{ matrix.go-module }}
90-
# coverageCommand: go test -race -cover -v -coverprofile ${{ matrix.go-module }}_coverage.out ./...
91-
# prefix: github.com/ARM-software/${{ github.event.repository.name }}/${{ matrix.go-module }}
92-
# coverageLocations:
93-
# "${{github.workspace}}/${{ matrix.go-module }}/${{ matrix.go-module }}_coverage.out:gocov"
94-
# - if: ${{ startsWith(matrix.os, 'windows') || startsWith(matrix.os, 'macOS') }}
9580
- name: Test ${{ matrix.go-module }} on ${{ matrix.os }}
9681
run: go test -race -cover -v ./...
9782
working-directory: ${{ matrix.go-module }}

.github/workflows/update-client.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,9 @@ jobs:
2525
token: ${{ secrets.GIT_SECRET }}
2626
repository: Arm-Debug/API-Uniform-Contract
2727
path: API-Uniform-Contract
28-
ref: production
29-
- uses: actions/upload-artifact@master
28+
ref: main
29+
# FIXME set to `production`
30+
- uses: actions/[email protected]
3031
with:
3132
name: all-service-flat
3233
path: API-Uniform-Contract/all/1/

.secrets.baseline

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -105,15 +105,6 @@
105105
}
106106
],
107107
"results": {
108-
"client/docs/AuthorizationAPI.md": [
109-
{
110-
"type": "Base64 High Entropy String",
111-
"filename": "client/docs/AuthorizationAPI.md",
112-
"hashed_secret": "b6c30ab47db0e58093620b979821ff3a0f14226d",
113-
"is_verified": false,
114-
"line_number": 39
115-
}
116-
],
117108
"client/docs/FPGAJobsAPI.md": [
118109
{
119110
"type": "Hex High Entropy String",
@@ -149,5 +140,5 @@
149140
}
150141
]
151142
},
152-
"generated_at": "2025-06-19T13:33:59Z"
143+
"generated_at": "2025-06-19T15:05:40Z"
153144
}

DEVELOPMENT.md

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -49,17 +49,6 @@ If you want to manually run all pre-commit hooks on a repository without creatin
4949

5050
To run individual hooks use `pre-commit run <hook_id>`.
5151

52-
## Code Climate
53-
54-
Code Climate is integrated with our GitHub flow. Failing the configured rules will yield a pull request not mergeable.
55-
56-
If you prefer to view the Code Climate report on your machine, prior to sending a pull request, you can use the [cli provided by Code Climate](https://docs.codeclimate.com/docs/command-line-interface).
57-
58-
Plugins for various tools are also available:
59-
- [Atom](https://docs.codeclimate.com/docs/code-climate-atom-package)
60-
- [PyCharm](https://plugins.jetbrains.com/plugin/13306-code-cleaner-with-code-climate-cli)
61-
- [Vim](https://docs.codeclimate.com/docs/vim-plugin)
62-
6352
# Dependency upgrades
6453

6554
For dependency upgrades, dependabot is relied upon and news files are auto-generated in order to document such change. Nonetheless, due to a change in [GitHub actions](https://github.blog/changelog/2021-02-19-github-actions-workflows-triggered-by-dependabot-prs-will-run-with-read-only-permissions), secrets are not available in the build triggered by the pull request unless they are [re-run manually](https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/automating-dependabot-with-github-actions#manually-re-running-a-workflow). So please re-run every dependabot PR CI jobs.

changes/20250613164851.misc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
:memo: Remove code climate references

changes/20250616131104.feature

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Updated client due to schema changes

changes/20250619151146.feature

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Updated client due to schema changes

client/.openapi-generator/FILES

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@ api_build_jobs.go
88
api_cmsis_builders.go
99
api_cmsis_intellisense_builders.go
1010
api_deprecation_notice.go
11+
api_fpga_admin.go
1112
api_fpga_connection.go
13+
api_fpga_entitlements.go
1214
api_fpga_jobs.go
1315
api_fpga_payloads.go
1416
api_fpgas.go
@@ -54,6 +56,7 @@ docs/EmbeddedBuildJobItems.md
5456
docs/EmbeddedCmsisBuilderItems.md
5557
docs/EmbeddedCmsisIntellisenseItems.md
5658
docs/EmbeddedEndpointDeprecationNoticeItems.md
59+
docs/EmbeddedFPGAAdminItem.md
5760
docs/EmbeddedFPGAConnectionItems.md
5861
docs/EmbeddedFPGAItems.md
5962
docs/EmbeddedFPGAJobItems.md
@@ -74,12 +77,17 @@ docs/EndpointDeprecationNotice.md
7477
docs/EndpointDeprecationNoticeCollection.md
7578
docs/EndpointDeprecationNoticeLinks.md
7679
docs/ErrorResponse.md
80+
docs/FPGAAdminAPI.md
81+
docs/FPGAAdminCollection.md
82+
docs/FPGAAdminItem.md
7783
docs/FPGACollection.md
7884
docs/FPGACollectionLinks.md
7985
docs/FPGAConnectionAPI.md
8086
docs/FPGAConnectionCollection.md
8187
docs/FPGAConnectionItem.md
8288
docs/FPGAConnectionItemLinks.md
89+
docs/FPGAEntitlementItem.md
90+
docs/FPGAEntitlementsAPI.md
8391
docs/FPGAItem.md
8492
docs/FPGAItemLinks.md
8593
docs/FPGAJobCollection.md
@@ -93,6 +101,7 @@ docs/FPGAPayloadRepositories.md
93101
docs/FPGAPayloadsAPI.md
94102
docs/FPGATarget.md
95103
docs/FPGATargetID.md
104+
docs/FPGAUARTConnection.md
96105
docs/FPGAWorkload.md
97106
docs/FPGAsAPI.md
98107
docs/FieldObject.md
@@ -134,6 +143,8 @@ docs/RetainBuildJobRequest.md
134143
docs/RetainWorkspaceRequest.md
135144
docs/RootResourceAPI.md
136145
docs/SimpleCollection.md
146+
docs/TokenIntrospectionRequestItem.md
147+
docs/TokenIntrospectionResponseItem.md
137148
docs/ToolchainTypes.md
138149
docs/UserCollection.md
139150
docs/UserInviteItem.md
@@ -193,6 +204,7 @@ model_embedded_build_job_items.go
193204
model_embedded_cmsis_builder_items.go
194205
model_embedded_cmsis_intellisense_items.go
195206
model_embedded_endpoint_deprecation_notice_items.go
207+
model_embedded_fpga_admin_item.go
196208
model_embedded_fpga_connection_items.go
197209
model_embedded_fpga_items.go
198210
model_embedded_fpga_job_items.go
@@ -214,11 +226,14 @@ model_endpoint_deprecation_notice_collection.go
214226
model_endpoint_deprecation_notice_links.go
215227
model_error_response.go
216228
model_field_object.go
229+
model_fpga_admin_collection.go
230+
model_fpga_admin_item.go
217231
model_fpga_collection.go
218232
model_fpga_collection_links.go
219233
model_fpga_connection_collection.go
220234
model_fpga_connection_item.go
221235
model_fpga_connection_item_links.go
236+
model_fpga_entitlement_item.go
222237
model_fpga_item.go
223238
model_fpga_item_links.go
224239
model_fpga_job_collection.go
@@ -231,6 +246,7 @@ model_fpga_payload_repositories.go
231246
model_fpga_target.go
232247
model_fpga_target_id.go
233248
model_fpga_workload.go
249+
model_fpgauart_connection.go
234250
model_generic_work_job_collection.go
235251
model_generic_work_job_item.go
236252
model_generic_work_job_item_links.go
@@ -264,6 +280,8 @@ model_resource_type_permission_item_links.go
264280
model_retain_build_job_request.go
265281
model_retain_workspace_request.go
266282
model_simple_collection.go
283+
model_token_introspection_request_item.go
284+
model_token_introspection_response_item.go
267285
model_toolchain_types.go
268286
model_user_collection.go
269287
model_user_invite_item.go
@@ -298,7 +316,9 @@ test/api_build_jobs_test.go
298316
test/api_cmsis_builders_test.go
299317
test/api_cmsis_intellisense_builders_test.go
300318
test/api_deprecation_notice_test.go
319+
test/api_fpga_admin_test.go
301320
test/api_fpga_connection_test.go
321+
test/api_fpga_entitlements_test.go
302322
test/api_fpga_jobs_test.go
303323
test/api_fpga_payloads_test.go
304324
test/api_fpgas_test.go

client/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,7 @@ Class | Method | HTTP request | Description
114114
*AuthenticationAPI* | [**GetUser**](docs/AuthenticationAPI.md#getuser) | **Get** /users/{userName} | Get user information
115115
*AuthenticationAPI* | [**InviteUser**](docs/AuthenticationAPI.md#inviteuser) | **Post** /users/invite | Invite a user.
116116
*AuthenticationAPI* | [**ListUsers**](docs/AuthenticationAPI.md#listusers) | **Get** /users/ | List all users
117+
*AuthenticationAPI* | [**TokenIntrospect**](docs/AuthenticationAPI.md#tokenintrospect) | **Post** /token/introspect | Introspect a token.
117118
*AuthorizationAPI* | [**CheckEntitlements**](docs/AuthorizationAPI.md#checkentitlements) | **Post** /entitlements/check | Check permissions on a resource.
118119
*AuthorizationAPI* | [**GetResourceInstanceEntitlements**](docs/AuthorizationAPI.md#getresourceinstanceentitlements) | **Get** /users/{userName}/entitlements/{resourceType}/instances/{resourceInstanceName} | Return details of the user&#39;s permissions for a resource instance.
119120
*AuthorizationAPI* | [**GetResourceTypeEntitlements**](docs/AuthorizationAPI.md#getresourcetypeentitlements) | **Get** /users/{userName}/entitlements/{resourceType} | Return details of the user&#39;s permissions for a resource type.
@@ -137,10 +138,15 @@ Class | Method | HTTP request | Description
137138
*CMSISIntellisenseBuildersAPI* | [**StartCmsisIntellisense**](docs/CMSISIntellisenseBuildersAPI.md#startcmsisintellisense) | **Post** /cmsis-intellisense/{builderName} | Initiate a compilation database generation using the specified CMSIS Intellisense Builder.
138139
*DeprecationNoticeAPI* | [**GetDeprecationNotice**](docs/DeprecationNoticeAPI.md#getdeprecationnotice) | **Get** /deprecations/{operationName} | Return details of specific endpoint deprecation notice.
139140
*DeprecationNoticeAPI* | [**ListDeprecatedEndpoints**](docs/DeprecationNoticeAPI.md#listdeprecatedendpoints) | **Get** /deprecations/ | Get the endpoints that have been deprecated with some notice.
141+
*FPGAAdminAPI* | [**AddFPGAAdmin**](docs/FPGAAdminAPI.md#addfpgaadmin) | **Post** /fpga-admins | Add a user to the FPGA admin group
142+
*FPGAAdminAPI* | [**ListFPGAAdmins**](docs/FPGAAdminAPI.md#listfpgaadmins) | **Get** /fpga-admins | List all the members of the FPGA admin group
143+
*FPGAAdminAPI* | [**RemoveFPGAAdmin**](docs/FPGAAdminAPI.md#removefpgaadmin) | **Delete** /fpga-admins/{fpgaAdminName} | Remove a user from the FPGA admin group
140144
*FPGAConnectionAPI* | [**GetFpgaConnection**](docs/FPGAConnectionAPI.md#getfpgaconnection) | **Get** /fpga-connections/{connectionName} | Get connection information
141145
*FPGAConnectionAPI* | [**ListFpgaConnections**](docs/FPGAConnectionAPI.md#listfpgaconnections) | **Get** /fpga-connections/ | List available FPGA connections.
142146
*FPGAConnectionAPI* | [**StartFpgaConnection**](docs/FPGAConnectionAPI.md#startfpgaconnection) | **Get** /fpga-connections/{connectionName}/connect | starts a websocket connection
143147
*FPGAConnectionAPI* | [**TerminateFpgaConnection**](docs/FPGAConnectionAPI.md#terminatefpgaconnection) | **Post** /fpga-connections/{connectionName}/terminate | Terminates all websocket connections to the application running on the FPGA
148+
*FPGAEntitlementsAPI* | [**GetFpgaEntitlement**](docs/FPGAEntitlementsAPI.md#getfpgaentitlement) | **Get** /fpga-entitlements/{fpgaEntitlementName} | Return details of specific FPGA entitlement.
149+
*FPGAEntitlementsAPI* | [**UpdateFPGAEntitlement**](docs/FPGAEntitlementsAPI.md#updatefpgaentitlement) | **Put** /fpga-entitlements | Update an FPGA entitlement that defines which users are permitted to interact with an FPGA.
144150
*FPGAJobsAPI* | [**CancelFpgaJob**](docs/FPGAJobsAPI.md#cancelfpgajob) | **Post** /fpga-jobs/{jobName}/cancel | Cancel an FPGA job.
145151
*FPGAJobsAPI* | [**ClearFpgaJobArtefact**](docs/FPGAJobsAPI.md#clearfpgajobartefact) | **Delete** /fpga-jobs/{jobName}/artefacts/{artefactName}/artefact | Clear the job artefact.
146152
*FPGAJobsAPI* | [**CreateFpgaJobArtefactManager**](docs/FPGAJobsAPI.md#createfpgajobartefactmanager) | **Post** /fpga-jobs/{jobName}/artefacts/ | Create a job artefact manager.
@@ -265,6 +271,7 @@ Class | Method | HTTP request | Description
265271
- [EmbeddedCmsisBuilderItems](docs/EmbeddedCmsisBuilderItems.md)
266272
- [EmbeddedCmsisIntellisenseItems](docs/EmbeddedCmsisIntellisenseItems.md)
267273
- [EmbeddedEndpointDeprecationNoticeItems](docs/EmbeddedEndpointDeprecationNoticeItems.md)
274+
- [EmbeddedFPGAAdminItem](docs/EmbeddedFPGAAdminItem.md)
268275
- [EmbeddedFPGAConnectionItems](docs/EmbeddedFPGAConnectionItems.md)
269276
- [EmbeddedFPGAItems](docs/EmbeddedFPGAItems.md)
270277
- [EmbeddedFPGAJobItems](docs/EmbeddedFPGAJobItems.md)
@@ -285,11 +292,14 @@ Class | Method | HTTP request | Description
285292
- [EndpointDeprecationNoticeCollection](docs/EndpointDeprecationNoticeCollection.md)
286293
- [EndpointDeprecationNoticeLinks](docs/EndpointDeprecationNoticeLinks.md)
287294
- [ErrorResponse](docs/ErrorResponse.md)
295+
- [FPGAAdminCollection](docs/FPGAAdminCollection.md)
296+
- [FPGAAdminItem](docs/FPGAAdminItem.md)
288297
- [FPGACollection](docs/FPGACollection.md)
289298
- [FPGACollectionLinks](docs/FPGACollectionLinks.md)
290299
- [FPGAConnectionCollection](docs/FPGAConnectionCollection.md)
291300
- [FPGAConnectionItem](docs/FPGAConnectionItem.md)
292301
- [FPGAConnectionItemLinks](docs/FPGAConnectionItemLinks.md)
302+
- [FPGAEntitlementItem](docs/FPGAEntitlementItem.md)
293303
- [FPGAItem](docs/FPGAItem.md)
294304
- [FPGAItemLinks](docs/FPGAItemLinks.md)
295305
- [FPGAJobCollection](docs/FPGAJobCollection.md)
@@ -301,6 +311,7 @@ Class | Method | HTTP request | Description
301311
- [FPGAPayloadRepositories](docs/FPGAPayloadRepositories.md)
302312
- [FPGATarget](docs/FPGATarget.md)
303313
- [FPGATargetID](docs/FPGATargetID.md)
314+
- [FPGAUARTConnection](docs/FPGAUARTConnection.md)
304315
- [FPGAWorkload](docs/FPGAWorkload.md)
305316
- [FieldObject](docs/FieldObject.md)
306317
- [GenericWorkJobCollection](docs/GenericWorkJobCollection.md)
@@ -336,6 +347,8 @@ Class | Method | HTTP request | Description
336347
- [RetainBuildJobRequest](docs/RetainBuildJobRequest.md)
337348
- [RetainWorkspaceRequest](docs/RetainWorkspaceRequest.md)
338349
- [SimpleCollection](docs/SimpleCollection.md)
350+
- [TokenIntrospectionRequestItem](docs/TokenIntrospectionRequestItem.md)
351+
- [TokenIntrospectionResponseItem](docs/TokenIntrospectionResponseItem.md)
339352
- [ToolchainTypes](docs/ToolchainTypes.md)
340353
- [UserCollection](docs/UserCollection.md)
341354
- [UserInviteItem](docs/UserInviteItem.md)

0 commit comments

Comments
 (0)