From f0295dd6162b7c610e8206fe47fe2f84f1aede2d Mon Sep 17 00:00:00 2001 From: Pavel Zwerschke Date: Sun, 28 Jan 2024 16:43:39 +0100 Subject: [PATCH 1/4] migrate to copier template --- .copier-answers.yml | 7 + .github/dependabot.yml | 2 +- .github/workflows/autoupdate.yml | 12 +- .github/workflows/ci.yml | 5 +- .github/workflows/keep-alive.yml | 11 +- .github/workflows/tag.yml | 2 +- .pre-commit-hooks.yaml | 5 +- LICENSE | 279 +------------------------------ README.md | 13 +- environment.yml | 3 +- 10 files changed, 39 insertions(+), 300 deletions(-) create mode 100644 .copier-answers.yml diff --git a/.copier-answers.yml b/.copier-answers.yml new file mode 100644 index 0000000..07ba275 --- /dev/null +++ b/.copier-answers.yml @@ -0,0 +1,7 @@ +# This file is managed by Copier; DO NOT EDIT OR REMOVE. +_commit: v0.1.4 +_src_path: git@github.com:quantco/copier-template-pre-commit-mirrors +description: This hook runs clang-tidy. +entry: clang-tidy +tool: clang-tidy +url: https://clang.llvm.org/extra/clang-tidy/ diff --git a/.github/dependabot.yml b/.github/dependabot.yml index a2a06ab..5a74cb9 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -3,7 +3,7 @@ updates: - package-ecosystem: github-actions directory: / schedule: - interval: weekly + interval: monthly reviewers: - quantco/ci groups: diff --git a/.github/workflows/autoupdate.yml b/.github/workflows/autoupdate.yml index 30614d8..920451b 100644 --- a/.github/workflows/autoupdate.yml +++ b/.github/workflows/autoupdate.yml @@ -1,8 +1,9 @@ name: Autoupdate + on: workflow_dispatch: schedule: - - cron: "0 */6 * * *" + - cron: "0 0 * * 0" defaults: run: @@ -16,11 +17,10 @@ jobs: steps: - name: Checkout branch uses: actions/checkout@v4 - with: - ref: ${{ github.head_ref }} - name: Set up Conda env - uses: mamba-org/provision-with-micromamba@3c96c0c27676490c63c18bc81f5c51895ac3e0e6 + uses: mamba-org/setup-micromamba@8767fb704bd78032e9392f0386bf46950bdd1194 with: + environment-file: environment.yml environment-name: check-env - name: Find latest version id: versions @@ -31,8 +31,8 @@ jobs: new_version=$(micromamba list -n check-env "$pkgname" --json | jq -r '.[0].version') if [[ "$new_version" != "$old_version" ]]; then sed -i "s/$old_version/$new_version/g" environment.yml - echo "pkgname=$pkgname" >> "$GITHUB_OUTPUT" - echo "new-version=$new_version" >> "$GITHUB_OUTPUT" + echo "pkgname=$pkgname" >> $GITHUB_OUTPUT + echo "new-version=$new_version" >> $GITHUB_OUTPUT fi - uses: peter-evans/create-pull-request@153407881ec5c347639a548ade7d8ad1d6740e38 if: steps.versions.outputs.pkgname diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index bb82897..a2d7155 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -3,7 +3,7 @@ name: CI on: push: branches: - - master + - main pull_request: jobs: @@ -16,6 +16,7 @@ jobs: with: ref: ${{ github.head_ref }} - name: Set up Conda env - uses: mamba-org/provision-with-micromamba@3c96c0c27676490c63c18bc81f5c51895ac3e0e6 + uses: mamba-org/setup-micromamba@8767fb704bd78032e9392f0386bf46950bdd1194 with: + environment-file: environment.yml environment-name: test-env diff --git a/.github/workflows/keep-alive.yml b/.github/workflows/keep-alive.yml index b6d789e..d36d27e 100644 --- a/.github/workflows/keep-alive.yml +++ b/.github/workflows/keep-alive.yml @@ -1,8 +1,7 @@ name: Keep on: - # pull_request: schedule: - - cron: "0 6 * * SUN" # Once weekly on Sunday @ 0600 UTC + - cron: 0 6 * * SUN jobs: keep-alive: @@ -10,9 +9,9 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - - uses: gautamkrishnar/keepalive-workflow@60b13c92aeda855e493b83aaf482c25da7e0043b + - uses: gautamkrishnar/keepalive-workflow@5b3128727d02fe1a892d0a2987517c9ec8ca7425 with: - commit_message: "Ah ah ah, stayin' alive" + commit_message: Ah ah ah, stayin' alive committer_username: ForrestQuant - committer_email: "forrestquant@users.noreply.github.com" - time_elapsed: 50 # days + committer_email: forrestquant@users.noreply.github.com + time_elapsed: 50 # days diff --git a/.github/workflows/tag.yml b/.github/workflows/tag.yml index 76ac726..27f220f 100644 --- a/.github/workflows/tag.yml +++ b/.github/workflows/tag.yml @@ -15,7 +15,7 @@ jobs: with: file: environment.yml token: ${{ secrets.GITHUB_TOKEN }} - version-extraction-override: 'regex:\s+- clangdev=(\d+.\d+.\d+)' + version-extraction-override: 'regex:\s+- clang-tidy=(\d+.\d+.\d+)' - name: Bump tag if: steps.version-metadata.outputs.changed == 'true' run: | diff --git a/.pre-commit-hooks.yaml b/.pre-commit-hooks.yaml index 3773cf3..9ca7da1 100644 --- a/.pre-commit-hooks.yaml +++ b/.pre-commit-hooks.yaml @@ -1,8 +1,7 @@ - id: clang-tidy-conda name: clang-tidy-conda + description: 'This hook runs clang-tidy.' entry: clang-tidy language: conda - 'types': ['c++'] - args: [] + types: ['c++'] require_serial: true - additional_dependencies: [] diff --git a/LICENSE b/LICENSE index 5715176..1f66540 100644 --- a/LICENSE +++ b/LICENSE @@ -1,278 +1,11 @@ -============================================================================== -The LLVM Project is under the Apache License v2.0 with LLVM Exceptions: -============================================================================== +Copyright 2024 QuantCo, Inc. - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ +Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION +1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. - 1. Definitions. +2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. +3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. - "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. - - ----- LLVM Exceptions to the Apache 2.0 License ---- - -As an exception, if, as a result of your compiling your source code, portions -of this Software are embedded into an Object form of such source code, you -may redistribute such embedded portions in such Object form without complying -with the conditions of Sections 4(a), 4(b) and 4(d) of the License. - -In addition, if you combine or link compiled forms of this Software with -software that is licensed under the GPLv2 ("Combined Software") and if a -court of competent jurisdiction determines that the patent provision (Section -3), the indemnity provision (Section 9) or other Section of the License -conflicts with the conditions of the GPLv2, you may retroactively and -prospectively choose to deem waived or otherwise exclude such Section(s) of -the License, but only in their entirety and only with respect to the Combined -Software. - -============================================================================== -Software from third parties included in the LLVM Project: -============================================================================== -The LLVM Project contains third party software which is under different license -terms. All such code will be identified clearly using at least one of two -mechanisms: -1) It will be in a separate directory tree with its own `LICENSE.txt` or - `LICENSE` file at the top containing the specific license and restrictions - which apply to that software, or -2) It will contain specific license and restriction terms at the top of every - file. - -============================================================================== -Legacy LLVM License (https://llvm.org/docs/DeveloperPolicy.html#legacy): -============================================================================== -University of Illinois/NCSA -Open Source License - -Copyright (c) 2003-2019 University of Illinois at Urbana-Champaign. -All rights reserved. - -Developed by: - - LLVM Team - - University of Illinois at Urbana-Champaign - - http://llvm.org - -Permission is hereby granted, free of charge, to any person obtaining a copy of -this software and associated documentation files (the "Software"), to deal with -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: - - * Redistributions of source code must retain the above copyright notice, - this list of conditions and the following disclaimers. - - * Redistributions in binary form must reproduce the above copyright notice, - this list of conditions and the following disclaimers in the - documentation and/or other materials provided with the distribution. - - * Neither the names of the LLVM Team, University of Illinois at - Urbana-Champaign, nor the names of its contributors may be used to - endorse or promote products derived from this Software without specific - prior written permission. - -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 -CONTRIBUTORS 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 WITH THE -SOFTWARE. +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/README.md b/README.md index 733a83c..f566ec1 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,18 @@ -clang-tidy(-conda) mirror -=================== +# clang-tidy mirror Mirror of clang-tidy for pre-commit with conda as a language. -* For pre-commit: see https://github.com/pre-commit/pre-commit -* For clang-tidy: see https://clang.llvm.org/extra/clang-tidy/ +For pre-commit: see [here](https://github.com/pre-commit/pre-commit) -### Using clang-tidy with pre-commit and conda: +For clang-tidy: see [here](https://clang.llvm.org/extra/clang-tidy/) + +## Using clang-tidy with pre-commit and conda: Add this to your `.pre-commit-config.yaml` ```yaml - - repo: https://github.com/Quantco/pre-commit-mirrors-clang-tidy + - repo: https://github.com/quantco/pre-commit-mirrors-clang-tidy rev: '' # Use the sha / tag you want to point at hooks: - id: clang-tidy-conda ``` - diff --git a/environment.yml b/environment.yml index bec4ed2..f2f2a0f 100644 --- a/environment.yml +++ b/environment.yml @@ -1,4 +1,5 @@ channels: - conda-forge + - nodefaults dependencies: - - clangdev=17.0.6 + - clang-tidy=null From 2e3c8457147d5f403cb358bce85f9ea0363e13ad Mon Sep 17 00:00:00 2001 From: Pavel Zwerschke Date: Sun, 28 Jan 2024 16:55:15 +0100 Subject: [PATCH 2/4] Fix dependency name --- environment.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/environment.yml b/environment.yml index f2f2a0f..9aaf4cb 100644 --- a/environment.yml +++ b/environment.yml @@ -2,4 +2,4 @@ channels: - conda-forge - nodefaults dependencies: - - clang-tidy=null + - clangdev=17.0.6 From 51e6c3462b4498adfee76436db8ec7ad2418427f Mon Sep 17 00:00:00 2001 From: Pavel Zwerschke Date: Sun, 28 Jan 2024 20:13:22 +0100 Subject: [PATCH 3/4] Update tag.yml --- .github/workflows/tag.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/tag.yml b/.github/workflows/tag.yml index 27f220f..76ac726 100644 --- a/.github/workflows/tag.yml +++ b/.github/workflows/tag.yml @@ -15,7 +15,7 @@ jobs: with: file: environment.yml token: ${{ secrets.GITHUB_TOKEN }} - version-extraction-override: 'regex:\s+- clang-tidy=(\d+.\d+.\d+)' + version-extraction-override: 'regex:\s+- clangdev=(\d+.\d+.\d+)' - name: Bump tag if: steps.version-metadata.outputs.changed == 'true' run: | From c8ed133acc2759d1ea061c3e3a3b4192d9d4979a Mon Sep 17 00:00:00 2001 From: Pavel Zwerschke Date: Wed, 31 Jan 2024 19:50:06 +0100 Subject: [PATCH 4/4] Update .copier-answers.yml --- .copier-answers.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.copier-answers.yml b/.copier-answers.yml index 07ba275..fa25955 100644 --- a/.copier-answers.yml +++ b/.copier-answers.yml @@ -1,6 +1,7 @@ # This file is managed by Copier; DO NOT EDIT OR REMOVE. _commit: v0.1.4 _src_path: git@github.com:quantco/copier-template-pre-commit-mirrors +conda_package: clangdev description: This hook runs clang-tidy. entry: clang-tidy tool: clang-tidy