Introducing elisp repo kit, a kit for repos

Signed-off-by: Psionik K <[email protected]>

Author: psionic-k

.envrc

@@ -0,0 +1 @@
+use flake

.github/pull_request_template.md

@@ -0,0 +1,20 @@
+## Pull Requests
+
+Generated changes to the flake.lock should be kept in a separate commit for the
+reviewer.
+
+Keeping these changes isolated in specific commits makes it much easier to pull
+in your changes in parallel with other features.  Maintainers may harvest your
+changes.  We only guarantee to preserve authorship, signature, and sign-off in
+the git log.
+
+### Creating pull requests
+
+1. Fork this repository into the personal GitHub account
+1. Make changes on the personal fork
+1. Remember to sign off and sign all commits in your PR branch (instructions in readme)
+1. Make a Pull Request against this repository
+1. **Allow maintainers to make changes to your pull request** (there's a
+   checkbox)
+1. Once the pull request has been approved, you will be thanked and observe your
+   changes applied with authorshi, signature, and sign-off in the git log

.github/workflows/ci.yml

@@ -0,0 +1,108 @@
+# Copyright (C) 2022 <Positron Solutions>
+
+# 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.
+
+name: CI
+
+on: # trigger this workflow on
+  push:
+    branches: [ $default-branch ] # pushes to the default branch
+  pull_request:
+    # or every pull request, from any branch to any branch
+
+  workflow_dispatch:
+    # Allows you to run this workflow manually from the Actions tab
+
+jobs:
+  continuous-integration: # just a job name
+
+    # Run on every OS and Emacsen
+    # Some steps specify their own logic!
+    strategy:
+      # Don't abort steps if any fails on any platform
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        emacsPkg: [ emacsNativeComp
+                    emacsUnstable
+                    # emacsGit
+                    # emacs
+                  ]
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - uses: actions/[email protected]
+      - uses: cachix/install-nix-action@v15
+        with:
+          extra_nix_config: |
+            access-tokens = github.com=${{ secrets.GITHUB_TOKEN }}
+      - uses: cachix/cachix-action@v10
+        with:
+          name: cargo2nix-gh
+          # This CACHIX_AUTH_TOKEN is a secret you must provide
+          authToken: ${{ secrets.CACHIX_AUTH_TOKEN }}
+          # Some paths may confuse cachix.  Add them with a pipe to the pushFilter
+          # pushFilter: "(something-else$|.drv.chroot$)"
+
+      # Loading the development shell with frozen versions is important to
+      # verify that any flake commands will successfully run straight off of the
+      # github repository.
+      - name: load the shell with frozen versions
+        run: nix develop .#${{ matrix.emacsPkg }} --ignore-environment --command "emacs" "--version"
+
+      # Linting the package is less useful on multiple version.  Modify the
+      # logic if you wish to expand lint coverage.
+      - name: lint package
+        if: matrix.emacsPkgs == "emacsNativeComp" && matrix.os == "ubuntu-latest"
+        run: |
+          nix develop \
+            --override-input nixpkgs github:nixos/nixpkgs/release-22.05
+            --update-input emacs-overlay \
+            .#${{ matrix.emacsPkg }}
+
+          # Lint the package
+          emacs --script ./test/elisp-repo-kit-lint.el
+
+          # Lint the tests
+          emacs --script test/elisp-repo-kit-lint-tests.el
+
+      - name: run tests
+        run: |
+          # First load the shell.  Updating inputs will update the view of ELPA
+          # Emacs git, and nixpkgs.
+
+          # Possible RUNNER_OS values: Windows Linux MacOS
+          # https://docs.github.com/en/actions/learn-github-actions/environment-variables#default-environment-variables
+          if [[ $RUNNER_OS == Linux ]]; then
+            nix develop \
+              --override-input nixpkgs github:nixos/nixpkgs/release-22.05
+              --update-input emacs-overlay \
+              .#${{ matrix.emacsPkg }}
+
+          else
+            nix develop \
+              --override-input nixpkgs github:nixos/nixpkgs/nixpkgs-22.05-darwin
+              --update-input emacs-overlay
+              .#${{ matrix.emacsPkg }}
+          fi
+
+          # Runs the tests
+          emacs --quick --load test/emacs-repo-kit-test-setup.el -- $GITHUB_SHA
+
+          # If you need terminal tests too, uncomment
+          # emacs --script test/emacs-repo-kit-test-setup.el -- $GITHUB_SHA

.github/workflows/dco.yml

@@ -0,0 +1,35 @@
+# Copyright (C) 2022 Positron Solutions
+
+# 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.
+
+# This Developer Certificate of Origin check verifies that all commits in a PR
+# are signed off on by the author.  It only needs to run once on each PR
+# update.
+#
+# The check is added as a shield to the project's README.org so that all can see
+# the license check for the entire commit history.
+
+name: DCO Check
+
+on: [pull_request]
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: tisonkun/[email protected]

.gitignore

@@ -0,0 +1,4 @@
+.direnv/
+**.elc
+**.el~
+**/*autoloads.el

COPYING

@@ -0,0 +1,18 @@
+Copyright (C) 2022 Positron Solutions
+
+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.

DCO

@@ -0,0 +1,34 @@
+Developer Certificate of Origin
+Version 1.1
+
+Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
+
+Everyone is permitted to copy and distribute verbatim copies of this
+license document, but changing it is not allowed.
+
+
+Developer's Certificate of Origin 1.1
+
+By making a contribution to this project, I certify that:
+
+(a) The contribution was created in whole or in part by me and I
+    have the right to submit it under the open source license
+    indicated in the file; or
+
+(b) The contribution is based upon previous work that, to the best
+    of my knowledge, is covered under an appropriate open source
+    license and I have the right under that license to submit that
+    work with modifications, whether created in whole or in part
+    by me, under the same open source license (unless I am
+    permitted to submit under a different license), as indicated
+    in the file; or
+
+(c) The contribution was provided directly to me by some other
+    person who certified (a), (b) or (c) and I have not modified
+    it.
+
+(d) I understand and agree that this project and the contribution
+    are public and that a record of the contribution (including all
+    personal information I submit with it, including my sign-off) is
+    maintained indefinitely and may be redistributed consistent with
+    this project or the open source license(s) involved.