cookiecutter (WIP)

Author: pythoninthegrass

.github/workflows/codeql_analysis.yml

@@ -9,7 +9,7 @@
   "version": "0.1.0",
   "use_pytest": "n",
   "use_black": "n",
-  "use_pypi_deployment_with_travis": "y",
+  "use_pypi_deployment_with_travis": "n",
   "add_pyup_badge": "n",
   "command_line_interface": [
     "Click",

cookiecutter.json

@@ -0,0 +1,13 @@
+# These are supported funding model platforms
+
+github: []
+# custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
+# patreon: # Replace with a single Patreon username
+# open_collective: # Replace with a single Open Collective username
+# ko_fi: # Replace with a single Ko-fi username
+# tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+# community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+# liberapay: # Replace with a single Liberapay username
+# issuehunt: # Replace with a single IssueHunt username
+# otechie: # Replace with a single Otechie username
+# lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry

{{cookiecutter.project_slug}}/.github/FUNDING.yml

@@ -0,0 +1,18 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+# https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#package-ecosystem
+# https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#directory
+
+version: 2
+updates:
+  - package-ecosystem: "pip"      # package manager
+    directory: "/"                # Files stored in repository root
+    schedule:
+      interval: "weekly"
+      day: "saturday"
+      time: "10:00"
+      timezone: "America/Chicago"
+    open-pull-requests-limit: 5
+    versioning-strategy: increase-if-necessary

{{cookiecutter.project_slug}}/.github/dependabot.yml

@@ -0,0 +1,79 @@
+name: Autoupdate project structure
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: "0 0 * * *"  # at the end of every day
+{% raw %}
+jobs:
+  auto-update-project:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.10
+
+      - name: Install dependencies
+        run: python -m pip install cruft poetry jello tabulate
+
+      - name: Update project structure
+        run: |
+          cruft update -y
+
+      - name: Check if there are changes
+        id: changes
+        run: echo "::set-output name=changed::$(git status --porcelain | wc -l)"
+
+      - name: apply additional changes and fixes
+        if: steps.changes.outputs.changed > 0
+        run: |
+          poetry lock --no-update  # add new dependencies
+          poetry install
+          poetry run pre-commit run -a || true  # we have to fix other issues manually
+
+      - name: Get template versions
+        id: get_versions
+        if: steps.changes.outputs.changed > 0
+        shell: bash
+        run: |
+          CURRENT_VERSION=$(git show HEAD:.cruft.json | jello -r "_['commit'][:8]")
+          NEXT_VERSION=$(jello -r "_['commit'][:8]" < .cruft.json)
+          echo ::set-output name="current_version::$CURRENT_VERSION"
+          echo ::set-output name="next_version::$NEXT_VERSION"
+
+      - name: Get changelog
+        id: get_changelog
+        if: steps.changes.outputs.changed > 0
+        shell: bash
+        run: |
+          TEMPLATE=$(jello -r "_['template']" < .cruft.json)
+          git clone "$TEMPLATE" /tmp/template
+          cd /tmp/template
+          body=$( (echo "Date;Change;Hash"; git log --pretty=format:"%as;%s;%h" ${{ steps.get_versions.outputs.current_version }}..${{ steps.get_versions.outputs.next_version }}) | tabulate --header --format github -s ';' -)
+          body=$(cat <<EOF
+          Changes from $TEMPLATE
+
+          $body
+          EOF
+          )
+          body="${body//'%'/'%25'}"
+          body="${body//$'\n'/'%0A'}"
+          body="${body//$'\r'/'%0D'}"
+          echo ::set-output name="changelog::$body"
+
+      # behaviour if PR already exists: https://github.com/marketplace/actions/create-pull-request#action-behaviour
+      - name: Create Pull Request
+        env:
+          # a PAT is required to be able to update workflows
+          GITHUB_TOKEN: ${{ secrets.AUTO_UPDATE_GITHUB_TOKEN }}
+        if: ${{ steps.changes.outputs.changed > 0 && env.GITHUB_TOKEN != 0 }}
+        uses: peter-evans/create-pull-request@v3
+        with:
+          token: ${{ env.GITHUB_TOKEN }}
+          commit-message: >-
+            chore: update project structure to ${{ steps.get_versions.outputs.next_version }}
+          title: "[Actions] Auto-Update cookiecutter template"
+          body: ${{ steps.get_changelog.outputs.changelog }}
+          branch: chore/auto-update-project-from-template
+          delete-branch: true{% endraw %}

.github/workflows/auto_merge.yml …_slug}}/.github/workflows/auto_merge.yml.github/workflows/auto_merge.yml renamed to {{cookiecutter.project_slug}}/.github/workflows/auto_merge.yml .github/workflows/auto_merge.yml renamed to {{cookiecutter.project_slug}}/.github/workflows/auto_merge.yml

@@ -15,14 +15,18 @@ def gitleaksEnabled():
 
 
 if gitleaksEnabled():
-    exitCode = os.WEXITSTATUS(os.system('gitleaks protect -v --staged'))
+    exitCode = os.WEXITSTATUS(os.system("gitleaks protect -v --staged"))
     if exitCode == 1:
-        print('''Warning: gitleaks has detected sensitive information in your changes.
+        print(
+            """Warning: gitleaks has detected sensitive information in your changes.
 To disable the gitleaks precommit hook run the following command:
 
     git config hooks.gitleaks false
-''')
+"""
+        )
         sys.exit(1)
 else:
-    print('gitleaks precommit disabled\
-     (enable with `git config hooks.gitleaks true`)')
+    print(
+        "gitleaks precommit disabled\
+     (enable with `git config hooks.gitleaks true`)"
+    )