diff --git a/.github/ISSUE_TEMPLATE/README.md b/.github/ISSUE_TEMPLATE/README.md index a6ff571..e6feee2 100644 --- a/.github/ISSUE_TEMPLATE/README.md +++ b/.github/ISSUE_TEMPLATE/README.md @@ -1,2 +1,23 @@ + + + + IS Logo + + # Issue Template Guide +![repo linter workflow](https://github.com/initialstate/best-practice-resources/actions/workflows/is-repo-lint.yml/badge.svg) +> [Link to Github docs](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository) + +A brief explanation of issue templates and how to use them. + +## Getting Started + +If you want to make your own organization wide template, just create a yaml file in this directory that follows [Github's formatting guidelines](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms). You can also use an [existing issue template](https://github.com/initialstate/.github/blob/master/.github/ISSUE_TEMPLATE/bug_report.yml) as a starting point. + +## Usage + +Issue templates made here will appear as options when creating an issue on any *public* repository. + +## Repository Checklist +The `new_repo_checklist.yml` template is meant to be used as a way to create checklists on newly created repositories when setting them up. Any new workflows/requirements should be added to that checklist. diff --git a/.github/ISSUE_TEMPLATE/new_repo_checklist.yml b/.github/ISSUE_TEMPLATE/new_repo_checklist.yml new file mode 100644 index 0000000..7312cce --- /dev/null +++ b/.github/ISSUE_TEMPLATE/new_repo_checklist.yml @@ -0,0 +1,30 @@ +name: ✅New Repository Checklist +description: New repositories should complete this checklist +title: "[CHECKLIST]: NEW REPOSITORY SETTINGS" +labels: ["enhancement"] +body: + - type: markdown + attributes: + value: | + Congrats on creating a new repository! Please make sure your new repo meets these requirements. + + - type: checkboxes + id: repo-items + attributes: + label: Have you added any of the following to your repo yet? + description: You may select more than one. Click on each for more information. + options: + - label: -[README that follows guidelines](https://github.com/initialstate/best-practice-resources/blob/master/README-templates) + - label: -[LICENSE](https://github.com/initialstate/best-practice-resources/blob/master/README.md#license) + - label: -[Global Codeowner](https://github.com/initialstate/best-practice-resources/blob/master/.github/folder-guide.md#codeowners) + - label: -[Branch Protection](https://github.com/initialstate/best-practice-resources/blob/master/README.md#branch-protection) + - label: -[dependabot](https://github.com/initialstate/best-practice-resources/blob/master/.github/folder-guide.md#dependabot) + - label: -[Repo Lint Action](https://github.com/initialstate/best-practice-resources/blob/master/.github/folder-guide.md#repo-lint) + - label: -[CLA Assistant](https://github.com/initialstate/best-practice-resources/blob/master/.github/folder-guide.md#cla-assistant) + - label: -[CodeScan](https://github.com/initialstate/best-practice-resources/blob/master/.github/folder-guide.md#codescan) + - label: -[About description with topics](https://github.com/initialstate/best-practice-resources/blob/master/README.md#topics) + + - type: markdown + attributes: + value: | + If you weren't able to check all of the boxes, please see the [best practices documentation](https://github.com/initialstate/best-practice-resources) for detailed instructions on how to add each requirement. diff --git a/.github/dependabot.yml b/.github/dependabot.yml index c5f8d97..38738f7 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -3,7 +3,7 @@ updates: - package-ecosystem: github-actions directory: / schedule: - interval: daily + interval: monthly labels: - "gh-actions" - "dependencies" diff --git a/.github/workflows/cla.yml b/.github/workflows/cla.yml index 07e4d46..bb5de8d 100644 --- a/.github/workflows/cla.yml +++ b/.github/workflows/cla.yml @@ -5,24 +5,47 @@ on: pull_request_target: types: [opened,closed,synchronize] +# select correct state for repository +env: + # state: private + state: public + jobs: + public-or-private-repo: + runs-on: ubuntu-latest + outputs: + repostate: ${{ steps.repo-state.outputs.repostate }} + steps: + + - name: Repo state + id: repo-state + run: echo "repostate=${{env.state}}" >> $GITHUB_OUTPUT + - name: Repo public? + if: "${{ env.state == 'public' }}" + run: echo "Workflow has repo set as public. If this is incorrect, uncomment line 10." + - name: Repo private? + if: "${{ env.state == 'private' }}" + run: echo "Workflow has repo set as private. If this is incorrect, uncomment line 11." + CLAssistant: + needs: public-or-private-repo + if: needs.public-or-private-repo.outputs.repostate == 'public' runs-on: ubuntu-latest steps: - name: "CLA Assistant" if: (github.event.comment.body == 'recheck' || github.event.comment.body == 'I have read the CLA Document and I hereby sign the CLA') || github.event_name == 'pull_request_target' # Beta Release - uses: contributor-assistant/github-action@v2.2.0 + uses: contributor-assistant/github-action@v2.3.0 env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # the below token should have repo scope and must be manually added by you in the repository's secret - PERSONAL_ACCESS_TOKEN : ${{ secrets.PERSONAL_ACCESS_TOKEN }} + PERSONAL_ACCESS_TOKEN : ${{ secrets.CLA_BOT_GH_ACCESS_TOKEN }} with: path-to-signatures: 'signatures/version1/cla.json' path-to-document: 'https://github.com/cla-assistant/github-action/blob/master/SAPCLA.md' # e.g. a CLA or a DCO document # branch should not be protected branch: 'master' - allowlist: bot* + allowlist: bot*, dependabot[bot], davidsulpy, rkuhlman, adametry, bborntrager, RChloe, TJBIII, JeffLoucks, krcummings1, ijavierTek #below are the optional inputs - If the optional inputs are not given, then default values will be taken remote-organization-name: 'initialstate' diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml new file mode 100644 index 0000000..06dac4c --- /dev/null +++ b/.github/workflows/codeql-analysis.yml @@ -0,0 +1,98 @@ +# 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: [ "master" ] + pull_request: + # The branches below must be a subset of the branches above + branches: [ "master" ] + schedule: + - cron: '17 16 * * 4' + +# select correct state for repository +env: + state: private + # state: public + +jobs: + public-or-private-repo: + runs-on: ubuntu-latest + outputs: + repostate: ${{ steps.repo-state.outputs.repostate }} + steps: + + - name: Repo state + id: repo-state + run: echo "repostate=${{env.state}}" >> $GITHUB_OUTPUT + - name: Repo public? + if: "${{ env.state == 'public' }}" + run: echo "Workflow has repo set as public. If this is incorrect, uncomment line 25." + - name: Repo private? + if: "${{ env.state == 'private' }}" + run: echo "Workflow has repo set as private. If this is incorrect, uncomment line 26." + +# REMEMBER TO CHECK `LANGUAGE` MATRIX FOR CORRECT LANGUAGE SETTINGS + analyze: + needs: public-or-private-repo + if: needs.public-or-private-repo.outputs.repostate == 'public' + name: Analyze + runs-on: ubuntu-latest + permissions: + actions: read + contents: read + security-events: write + + strategy: + fail-fast: false + matrix: + language: [ 'python' ] + # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ] + # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support + + steps: + - name: Checkout repository + uses: actions/checkout@v3 + + # Initializes the CodeQL tools for scanning. + - name: Initialize CodeQL + uses: github/codeql-action/init@v2 + 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. + + # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs + # queries: security-extended,security-and-quality + + + # 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@v2 + + # ℹ️ Command-line programs to run using the OS shell. + # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun + + # If the Autobuild fails above, remove it and uncomment the following three lines. + # modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance. + + # - run: | + # echo "Run, Build Application using script" + # ./location_of_script_within_repo/buildscript.sh + + - name: Perform CodeQL Analysis + uses: github/codeql-action/analyze@v2 + with: + category: "/language:${{matrix.language}}" diff --git a/.github/workflows/is-repo-lint.yml b/.github/workflows/is-repo-lint.yml index 87640d7..1f8f1d2 100644 --- a/.github/workflows/is-repo-lint.yml +++ b/.github/workflows/is-repo-lint.yml @@ -1,11 +1,33 @@ name: is-repo-lint on: push: - branches: [ $default-branch ] + branches: [ "master" ] pull_request: - branches: [ $default-branch ] + branches: [ "master" ] workflow_dispatch: + +# select correct state for repository +env: + state: private + # state: public + jobs: + public-or-private-repo: + runs-on: ubuntu-latest + outputs: + repostate: ${{ steps.repo-state.outputs.repostate }} + steps: + + - name: Repo state + id: repo-state + run: echo "repostate=${{env.state}}" >> $GITHUB_OUTPUT + - name: Repo public? + if: "${{ env.state == 'public' }}" + run: echo "Workflow has repo set as public. If this is incorrect, uncomment line 11." + - name: Repo private? + if: "${{ env.state == 'private' }}" + run: echo "Workflow has repo set as private. If this is incorrect, uncomment line 12." + check-for-codeowners-file: runs-on: ubuntu-latest steps: @@ -29,7 +51,7 @@ jobs: - name: CODEOWNERS file does not exist if: steps.codeowners_file.outputs.file_exists == 'false' run: echo CODEOWNERS file does not exist! - + check-for-readme-file: runs-on: ubuntu-latest steps: @@ -55,6 +77,8 @@ jobs: run: echo README file does not exist! check-for-license: + needs: public-or-private-repo + if: needs.public-or-private-repo.outputs.repostate == 'public' runs-on: ubuntu-latest steps: @@ -102,15 +126,41 @@ jobs: if: steps.dependabot_file.outputs.file_exists == 'false' run: echo dependabot file does not exist! - check-for-personal-access-token: - runs-on: ubuntu-latest - steps: - - - name: Check for missing PERSONAL_ACCESS_TOKEN - env: - MY_KEY: ${{ secrets.PERSONAL_ACCESS_TOKEN }} - if: "${{ env.MY_KEY == '' }}" - uses: actions/github-script@v3 - with: - script: | - core.setFailed('PERSONAL_ACCESS_TOKEN secret is missing. It is needed to successfully run the CLA assistant.') + check-for-codeql-file: + runs-on: ubuntu-latest + steps: + + - name: Checkout repo + uses: actions/checkout@v3 + + - name: Check for codeql-analysis.yml + id: codeql-analysis_file + uses: initialstate/file-check-action@v1 + with: + file: ".github/workflows/codeql-analysis.yml" + + - name: codeql-analysis.yml file Output Test + run: echo ${{ steps.codeql-analysis_file.outputs.file_exists }} + + - name: codeql-analysis file exists with content + if: steps.codeql-analysis_file.outputs.file_exists == 'true' + run: echo codeql-analysis file exists! + + - name: codeql-analysis file does not exist + if: steps.codeql-analysis_file.outputs.file_exists == 'false' + run: echo codeql-analysis file does not exist! + + check-for-cla-bot-gh-access-token: + needs: public-or-private-repo + if: needs.public-or-private-repo.outputs.repostate == 'public' + runs-on: ubuntu-latest + steps: + + - name: Check for missing CLA_BOT_GH_ACCESS_TOKEN + env: + MY_KEY: ${{ secrets.CLA_BOT_GH_ACCESS_TOKEN }} + if: "${{ env.MY_KEY == '' }}" + uses: actions/github-script@v6 + with: + script: | + core.setFailed('CLA_BOT_GH_ACCESS_TOKEN secret is missing. It is needed to successfully run the CLA assistant.') diff --git a/LICENSE.md b/LICENSE.md index 15fa121..261eeb9 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,21 +1,201 @@ -MIT License - -Copyright (c) 2022 Initial State - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -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. + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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. diff --git a/README.md b/README.md index e7a9e21..40d4bef 100644 --- a/README.md +++ b/README.md @@ -7,8 +7,10 @@ # .github ![repo linter workflow](https://github.com/initialstate/.github/actions/workflows/is-repo-lint.yml/badge.svg) +A special repository specifically for global templates and files. ## Globally applied templates - Bug reports/Feature requests under .github/ISSUE_TEMPLATE - Code of conduct under CODE_OF_CONDUCT.md +- Organization profile under profile/README.md diff --git a/profile/README.md b/profile/README.md index b917e5f..1eaf629 100644 --- a/profile/README.md +++ b/profile/README.md @@ -1,3 +1,9 @@ + + + + IS Logo + + ## IoT Platform for Data Visualizations Stream data from your device and services to beautiful cloud-based data visualizations.