From 33e4b7e557c644fcc918d862907b5753f4d55152 Mon Sep 17 00:00:00 2001 From: Nick Fyson Date: Mon, 9 Nov 2020 10:09:50 +0000 Subject: [PATCH 1/8] add codeql workflow --- code-scanning/codeql.yml | 67 +++++++++++++++++++ .../properties/codeql.properties.json | 7 ++ 2 files changed, 74 insertions(+) create mode 100644 code-scanning/codeql.yml create mode 100644 code-scanning/properties/codeql.properties.json diff --git a/code-scanning/codeql.yml b/code-scanning/codeql.yml new file mode 100644 index 0000000..09d68ef --- /dev/null +++ b/code-scanning/codeql.yml @@ -0,0 +1,67 @@ +# For most projects, this workflow file will not need changing; you simply need +# to commit it to your repository. +# +# You may wish to alter this file to override the set of languages analyzed, +# or to provide custom queries or build logic. +# +# ******** NOTE ******** +# We have attempted to detect the languages in your repository. Please check +# the `language` matrix defined below to confirm you have the correct set of +# supported CodeQL languages. +# +name: "CodeQL" + +on: + push: + branches: [ $default-branch, $protected-branches ] + pull_request: + # The branches below must be a subset of the branches above + branches: [ $default-branch ] + schedule: + - cron: $cron-weekly + +jobs: + analyze: + name: Analyze + runs-on: ubuntu-latest + + strategy: + fail-fast: false + matrix: + language: [ $detected-codeql-languages ] + # CodeQL supports [ $supported-codeql-languages ] + # Learn more... + # https://docs.github.com/en/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#overriding-automatic-language-detection + + steps: + - name: Checkout repository + uses: actions/checkout@v2 + + # Initializes the CodeQL tools for scanning. + - name: Initialize CodeQL + uses: github/codeql-action/init@v1 + with: + languages: ${{ matrix.language }} + # If you wish to specify custom queries, you can do so here or in a config file. + # By default, queries listed here will override any specified in a config file. + # Prefix the list here with "+" to use these queries and those in the config file. + # queries: ./path/to/local/query, your-org/your-repo/queries@main + + # Autobuild attempts to build any compiled languages (C/C++, C#, or Java). + # If this step fails, then you should remove it and run the build manually (see below) + - name: Autobuild + uses: github/codeql-action/autobuild@v1 + + # ℹī¸ Command-line programs to run using the OS shell. + # 📚 https://git.io/JvXDl + + # ✏ī¸ If the Autobuild fails above, remove it and uncomment the following three lines + # and modify them (or add more) to build your code if your project + # uses a compiled language + + #- run: | + # make bootstrap + # make release + + - name: Perform CodeQL Analysis + uses: github/codeql-action/analyze@v1 diff --git a/code-scanning/properties/codeql.properties.json b/code-scanning/properties/codeql.properties.json new file mode 100644 index 0000000..cb9305a --- /dev/null +++ b/code-scanning/properties/codeql.properties.json @@ -0,0 +1,7 @@ +{ + "name": "CodeQL Analysis", + "creator": "GitHub", + "description": "Security analysis from GitHub for C, C++, C#, Java, JavaScript, TypeScript, Python, and Go developers.", + "iconName": "octicon mark-github", + "categories": ["Code Scanning", "C", "C#", "C++", "Go", "Java", "JavaScript", "TypeScript", "Python"] +} From 85739b01da473f4e2b77b53ffefd42338e600dff Mon Sep 17 00:00:00 2001 From: Nick Fyson Date: Wed, 11 Nov 2020 09:30:58 +0000 Subject: [PATCH 2/8] update terms and guidelines to account for code scanning workflows --- .github/pull_request_template.md | 11 ++++++----- CONTRIBUTING.md | 8 ++++---- LICENSE | 3 ++- README.md | 1 + 4 files changed, 13 insertions(+), 10 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index e79272c..67a60a7 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,4 +1,4 @@ -This repository contains configuration for what users see when they click on the `Actions` tab. +This repository contains configuration for what users see when they click on the `Actions` tab and the setup page for Code Scanning. It is not: * A playground to try out scripts @@ -6,7 +6,7 @@ It is not: --- -**Please note that we are not accepting new starter workflows at this time. Updates to existing starter workflows are fine.** +**Please note that at this time we are only accepting new starter workflows for Code Scanning. Updates to existing starter workflows are fine.** --- @@ -21,16 +21,17 @@ In the workflow and properties files: - [ ] Include comments in the workflow for any parts that are not obvious or could use clarification. - [ ] CI workflows should run on `push` to `branches: [ $default-branch ]` and `pull_request` to `branches: [ $default-branch ]`. - [ ] Packaging workflows should run on `release` with `types: [ created ]`. +- [ ] Code Scanning workflows should run on `push` to `branches: [ $default-branch, $protected-branches ]` and `pull_request` to `branches: [ $default-branch ]`. We also recommend a `schedule` trigger of `cron: $cron-weekly`. Some general notes: - [ ] This workflow must only use actions that are produced by GitHub, [in the `actions` organization](https://github.com/actions), **or** -- [ ] This workflow must only use actions that are produced by the language or ecosystem that the workflow supports. These actions must be [published to the GitHub Marketplace](https://github.com/marketplace?type=actions). Workflows using these actions must reference the action using the full 40 character hash of the action's commit instead of a tag. Additionally, workflows must include the following comment at the top of the workflow file: +- [ ] This workflow must only use actions that are produced by the language or ecosystem that the workflow supports. These actions must be [published to the GitHub Marketplace](https://github.com/marketplace?type=actions). We recommend that these actions be referenced using the full 40 character hash of the action's commit instead of a tag. Additionally, workflows must include the following comment at the top of the workflow file: ``` # 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. ``` -- [ ] This workflow must not send data to any 3rd party service except for the purposes of installing dependencies. -- [ ] This workflow must not use a paid service or product. +- [ ] Automation and CI workflows should not send data to any 3rd party service except for the purposes of installing dependencies. +- [ ] Automation and CI workflows cannot be dependent on a paid service or product. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8f9d704..c9e8299 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,7 +9,7 @@ Contributions to this project are [released](https://help.github.com/articles/gi Please note that this project is released with a [Contributor Code of Conduct]( https://github.com/actions/.github/blob/main/CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms. -**At this time we are not accepting any new starter workflows** +**At this time we are only accepting new starter workflows for Code Scanning** ### Previous guidelines for new starter workflows. @@ -17,8 +17,8 @@ Before merging a new workflow, the following requirements need to be met: - Should be as simple as is needed for the service. - There are many programming languages and tools out there. Right now we don't have a page that allows for a really large number of workflows, so we do have to be a little choosy about what we accept. Less popular tools or languages might not be accepted. -- Should not send data to any 3rd party service except for the purposes of installing dependencies. -- Cannot use an Action that isn't in the `actions` organization. -- Cannot be to a paid service or product. +- Automation and CI workflows should not send data to any 3rd party service except for the purposes of installing dependencies. +- Automation and CI workflows cannot be dependent on a paid service or product. +- We recommend that Actions outside of the `actions` organization be pinned to a specific SHA. Thank you diff --git a/LICENSE b/LICENSE index 331b241..658b968 100644 --- a/LICENSE +++ b/LICENSE @@ -18,4 +18,5 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. +SOFTWARE. THIS LICENSE DOES NOT GRANT YOU RIGHTS TO USE ANY CONTRIBUTORS' +NAME, LOGO, OR TRADEMARKS. diff --git a/README.md b/README.md index 6025c5c..e276691 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,7 @@ These are the workflow files for helping people get started with GitHub Actions. **Directory structure:** * [ci](ci): solutions for Continuous Integration * [automation](automation): solutions for automating workflows. +* [code-scanning](code-scanning): starter workflows for [Code Scanning](https://github.com/features/security) * [icons](icons): svg icons for the relevant template Each workflow must be written in YAML and have a `.yml` extension. They also need a corresponding `.properties.json` file that contains extra metadata about the workflow (this is displayed in the GitHub.com UI). From 500534878c28b83304ed572c7e9df8efa9ce86d8 Mon Sep 17 00:00:00 2001 From: Nick Fyson Date: Thu, 12 Nov 2020 12:42:47 +0000 Subject: [PATCH 3/8] update doc link in codeql template --- code-scanning/codeql.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/code-scanning/codeql.yml b/code-scanning/codeql.yml index 09d68ef..3e8f951 100644 --- a/code-scanning/codeql.yml +++ b/code-scanning/codeql.yml @@ -30,8 +30,8 @@ jobs: matrix: language: [ $detected-codeql-languages ] # CodeQL supports [ $supported-codeql-languages ] - # Learn more... - # https://docs.github.com/en/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#overriding-automatic-language-detection + # Learn more: + # https://docs.github.com/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed steps: - name: Checkout repository From 44c50acb70a47e6f3179276ba7ff9b7154a015cf Mon Sep 17 00:00:00 2001 From: Nick Fyson Date: Fri, 13 Nov 2020 16:33:01 +0000 Subject: [PATCH 4/8] amend link in codeql workflow --- code-scanning/codeql.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/code-scanning/codeql.yml b/code-scanning/codeql.yml index 3e8f951..d88fe52 100644 --- a/code-scanning/codeql.yml +++ b/code-scanning/codeql.yml @@ -31,7 +31,7 @@ jobs: language: [ $detected-codeql-languages ] # CodeQL supports [ $supported-codeql-languages ] # Learn more: - # https://docs.github.com/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed + # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed steps: - name: Checkout repository From ef7878c3e6b351a5baf052d25ce729e19680902c Mon Sep 17 00:00:00 2001 From: Christopher Schleiden Date: Thu, 19 Nov 2020 14:07:15 -0800 Subject: [PATCH 5/8] Add workflow_dispatch trigger to the default empty workflow --- ci/blank.yml | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/ci/blank.yml b/ci/blank.yml index f7816e9..79ba948 100644 --- a/ci/blank.yml +++ b/ci/blank.yml @@ -2,14 +2,17 @@ name: CI -# Controls when the action will run. Triggers the workflow on push or pull request -# events but only for the $default-branch branch +# Controls when the action will run. on: + # Triggers the workflow on push or pull request events but only for the $default-branch branch push: branches: [ $default-branch ] pull_request: branches: [ $default-branch ] + # This allows you to run this workflow manually from the Actions tab + workflow_dispatch: + # A workflow run is made up of one or more jobs that can run sequentially or in parallel jobs: # This workflow contains a single job called "build" From bfb45aec418510a5b68ad15395694db7907eca58 Mon Sep 17 00:00:00 2001 From: Christopher Schleiden Date: Thu, 19 Nov 2020 14:21:12 -0800 Subject: [PATCH 6/8] Shorten the description --- ci/blank.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ci/blank.yml b/ci/blank.yml index 79ba948..3214287 100644 --- a/ci/blank.yml +++ b/ci/blank.yml @@ -10,7 +10,7 @@ on: pull_request: branches: [ $default-branch ] - # This allows you to run this workflow manually from the Actions tab + # Allows you to run this workflow manually from the Actions tab workflow_dispatch: # A workflow run is made up of one or more jobs that can run sequentially or in parallel From 0e2cd77dc8a2aa3769619b37929a26765894e87a Mon Sep 17 00:00:00 2001 From: Robert Rosca <32569096+RobertRosca@users.noreply.github.com> Date: Mon, 23 Nov 2020 11:13:06 +0100 Subject: [PATCH 7/8] Use consistent calls to pip `pip` was called in two different ways which is a bit inconsistent, this change just makes it so that it is called in the same way both times. --- ci/python-package.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ci/python-package.yml b/ci/python-package.yml index c4a1081..403cecd 100644 --- a/ci/python-package.yml +++ b/ci/python-package.yml @@ -26,7 +26,7 @@ jobs: - name: Install dependencies run: | python -m pip install --upgrade pip - pip install flake8 pytest + python -m pip install flake8 pytest if [ -f requirements.txt ]; then pip install -r requirements.txt; fi - name: Lint with flake8 run: | From 64f653a8091f84182b1aa45ce63b0caaddfb94cd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oliver=20St=C3=A4bler?= Date: Tue, 24 Nov 2020 21:16:36 +0100 Subject: [PATCH 8/8] Build/Test all go packages Use the "..." pattern to build/test all go packages in a repository. --- ci/go.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/ci/go.yml b/ci/go.yml index 5531663..16bff70 100644 --- a/ci/go.yml +++ b/ci/go.yml @@ -30,7 +30,7 @@ jobs: fi - name: Build - run: go build -v . + run: go build -v ./... - name: Test - run: go test -v . + run: go test -v ./...