Merge pull request #210 from devfile/main

v2.2.2

Author: Jdubrick

.clomonitor.yml

@@ -0,0 +1,24 @@
+#
+# Copyright Red Hat
+#
+# 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.
+
+# CLOMonitor metadata file
+# This file must be located at the root of the repository
+
+# Checks exemptions
+exemptions:
+  - check: license_scanning # Check identifier (see https://github.com/cncf/clomonitor/blob/main/docs/checks.md#exemptions)
+    reason: "There are currently no plans moving forward to implement FOSSA or Snyk for scanning purposes." # Justification of this exemption (mandatory, it will be displayed on the UI)
+  - check: artifacthub_badge
+    reason: "This repository has no items that should be added to Artifact Hub."

.codecov.yaml

@@ -1,3 +1,18 @@
+#
+# Copyright Red Hat
+#
+# 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.
+
 # See http://docs.codecov.io/docs/coverage-configuration
 coverage:
   precision: 2 # 2 = xx.xx%, 0 = xx%
@@ -29,6 +44,8 @@ coverage:
     - "vendor/*"
     - "Makefile"
     - ".travis.yml"
+    - "pkg/devfile/parser/util/mock.go"
+    - "pkg/util/mock.go"
 
 # See http://docs.codecov.io/docs/pull-request-comments-1
 comment:

.github/PULL_REQUEST_TEMPLATE.md

@@ -5,14 +5,16 @@
 <!-- _Link to github issue(s)_ -->
 
 ### PR acceptance criteria:
-Testing and documentation do not need to be complete in order for this PR to be approved. We just need to ensure tracking issues are opened.
+Testing and documentation do not need to be complete in order for this PR to be approved. We just need to ensure tracking issues are opened and linked to this PR, if they are not in the PR scope due to various constraints.
 
-> - Open new test/doc issues under the [devfile/api](https://github.com/devfile/api/issues) repo
-> - Check each criteria if:
->  - There is a separate tracking issue. Add the issue link under the criteria
->  **or**
->  - test/doc updates are made as part of this PR
-> -  If unchecked, explain why it's not needed
+<!-- 
+- Open new test/doc issues under the [devfile/api](https://github.com/devfile/api/issues) repo
+- Check each criteria if:
+  - There is a separate tracking issue. Add the issue link under the criteria
+  **or**
+  - test/doc updates are made as part of this PR
+-  If unchecked, explain why it's not needed 
+-->
 
 
 - [ ] Unit/Functional tests
@@ -23,9 +25,9 @@ Testing and documentation do not need to be complete in order for this PR to be
 
   <!--  _Do we need to verify integration with ODO and Openshift console?_ -->
 
-- [ ] Documentation 
+- [ ] Documentation (READMEs, Product Docs, Blogs, Education Modules, etc.)
 
-   <!-- _This includes product docs and READMEs._ -->
+   <!-- _This includes READMEs, Product Docs, Blogs, Education Modules, etc._ -->
 
 - [ ] Client Impact
 

.github/workflows/codecov.yml

@@ -1,8 +1,26 @@
+#
+# Copyright Red Hat
+#
+# 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.
 name: Code Coverage Report
 on:
   push:
     branches:
       - main
+
+# Declare default permissions as read only.
+permissions: read-all
+
 jobs:
   build-and-deploy:
     runs-on: ubuntu-20.04
@@ -14,7 +32,7 @@ jobs:
       - name: Set up Go 1.x
         uses: actions/setup-go@93397bea11091df50f3d7e59dc26a7711a8bcfbe # v4.1.0
         with:
-          go-version: 1.19
+          go-version-file: 'go.mod'
       - name: Run tests
         run: make test
       - name: Codecov

.github/workflows/go.yml

@@ -1,3 +1,17 @@
+#
+# Copyright Red Hat
+#
+# 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.
 name: Validate PRs
 
 on:
@@ -6,22 +20,29 @@ on:
   pull_request:
     branches: [ main ]
 
-jobs:
+# Declare default permissions as read only.
+permissions: read-all
 
+jobs:
+  
   build:
     name: Build
     runs-on: ubuntu-latest
+    
+    permissions:
+      security-events: write
+
     steps:
 
+    - name: Check out code into the Go module directory
+      uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 # v3.5.3
+
     - name: Setup Go environment
       uses: actions/setup-go@93397bea11091df50f3d7e59dc26a7711a8bcfbe # v4.1.0
       with:
-        go-version: 1.19
+        go-version-file: 'go.mod'
       id: go
 
-    - name: Check out code into the Go module directory
-      uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 # v3.5.3
-
     - name: Check go mod status
       run: |
         make gomod_tidy

.github/workflows/proxy-warming.yml

@@ -1,3 +1,17 @@
+#
+# Copyright Red Hat
+#
+# 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.
 name: Renew documentation
 
 on:
@@ -7,6 +21,9 @@ on:
     tags:
       - 'v[0-9]+.[0-9]+.[0-9]+'
 
+# Declare default permissions as read only.
+permissions: read-all
+
 jobs:
   build:
     name: Renew documentation

.github/workflows/scorecard.yml

@@ -0,0 +1,83 @@
+#
+# Copyright Red Hat
+#
+# 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.
+
+# This workflow uses actions that are not certified by GitHub. They are provided
+# by a third-party and are governed by separate terms of service, privacy
+# policy, and support documentation.
+
+name: Scorecard supply-chain security
+on:
+  # For Branch-Protection check. Only the default branch is supported. See
+  # https://github.com/ossf/scorecard/blob/main/docs/checks.md#branch-protection
+  branch_protection_rule:
+  pull_request:
+    branches: [ "main" ]
+
+# Declare default permissions as read only.
+permissions: read-all
+
+jobs:
+  analysis:
+    name: Scorecard analysis
+    runs-on: ubuntu-latest
+    permissions:
+      # Needed to upload the results to code-scanning dashboard.
+      security-events: write
+      # Needed to publish results and get a badge (see publish_results below).
+      id-token: write
+      # Uncomment the permissions below if installing in a private repository.
+      # contents: read
+      # actions: read
+
+    steps:
+      - name: "Checkout code"
+        uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 # v3.5.3
+        with:
+          persist-credentials: false
+
+      - name: "Run analysis"
+        uses: ossf/scorecard-action@e38b1902ae4f44df626f11ba0734b14fb91f8f86 # v2.1.2
+        with:
+          results_file: results.sarif
+          results_format: sarif
+          # (Optional) "write" PAT token. Uncomment the `repo_token` line below if:
+          # - you want to enable the Branch-Protection check on a *public* repository, or
+          # - you are installing Scorecard on a *private* repository
+          # To create the PAT, follow the steps in https://github.com/ossf/scorecard-action#authentication-with-pat.
+          # repo_token: ${{ secrets.SCORECARD_TOKEN }}
+
+          # Public repositories:
+          #   - Publish results to OpenSSF REST API for easy access by consumers
+          #   - Allows the repository to include the Scorecard badge.
+          #   - See https://github.com/ossf/scorecard-action#publishing-results.
+          # For private repositories:
+          #   - `publish_results` will always be set to `false`, regardless
+          #     of the value entered here.
+          publish_results: true
+
+      # Upload the results as artifacts (optional). Commenting out will disable uploads of run results in SARIF
+      # format to the repository Actions tab.
+      - name: "Upload artifact"
+        uses: actions/upload-artifact@3cea5372237819ed00197afe530f5a7ea3e805c8 # v3.1.0
+        with:
+          name: SARIF file
+          path: results.sarif
+          retention-days: 5
+
+      # Upload the results to GitHub's code scanning dashboard.
+      - name: "Upload to code-scanning"
+        uses: github/codeql-action/upload-sarif@17573ee1cc1b9d061760f3a006fc4aac4f944fd5 # v2.2.4
+        with:
+          sarif_file: results.sarif

.gitignore

@@ -24,6 +24,7 @@ main
 # File created running tests
 tests/**/tmp/
 tests/v2/lib-test-coverage.*
+*resource.file*
 
 
 # Mac related files

CONTRIBUTING.md

@@ -16,7 +16,7 @@ contribution. See the [DCO](./DCO) file for details.
 The following are required to work on devfile library:
 
 - Git
-- Go 1.15 or later
+- Go 1.19 or later
 
 ## Code of Conduct
 Before contributing to this repository, see [contributor code of conduct](https://github.com/devfile/api/blob/main/CODE_OF_CONDUCT.md#contributor-covenant-code-of-conduct)
@@ -29,7 +29,7 @@ If you spot a problem with devfile library, [search if an issue already exists](
 
 ### Writing Code
 
-For writing the code just follow [Go guide](https://go.dev/doc/effective_go), and also test with [tesing](https://pkg.go.dev/testing). Remember to add new unit tests if new features have been introducted, or changes have been made to existing code. If there is something unclear of the style, just look at existing code which might help you to understand it better.
+For writing the code just follow [Go guide](https://go.dev/doc/effective_go), and also test with [testing](https://pkg.go.dev/testing). Remember to add new unit tests if new features have been introducted, or changes have been made to existing code. If there is something unclear of the style, just look at existing code which might help you to understand it better.
 
 ### Testing Changes
 To run unit tests and api tests. Visit [library tests](tests/README.md) to find out more information on tests
@@ -69,6 +69,6 @@ Running the script with no arguments will default to update the latest devfile v
 
 ### Releases
 
-Currently devfile library does not have schedule for new releases. A new version is being generated and released on demand. 
+Currently devfile library publish new releases annually. A new version can also be generated and released on demand.
 A new branch is expected to be created for a new release.
 To generate a changelog for a new release, execute `./scripts/changelog-script.sh v2.x.y` for all the changes since the release v2.x.y

Makefile

@@ -1,3 +1,18 @@
+#
+# Copyright Red Hat
+#
+# 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.
+
 FILES := main
 
 default: bin

OWNERS

@@ -3,14 +3,12 @@
 approvers:
 - amisevsk
 - elsony
+- Jdubrick
 - michael-valdron
 - thepetk
-- feloy
-- rm3l
 
 reviewers:
 - elsony
+- Jdubrick
 - michael-valdron
-- thepetk
-- feloy
-- rm3l
+- thepetk