Trying to fix lint issues

JuliaBesties · Sep 12, 2023 · 71b3c7d · 71b3c7d
1 parent e9fd554
commit 71b3c7d
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 6 deletions.
diff --git a/.github/workflows/Docs.yml.jinja b/.github/workflows/Docs.yml.jinja
@@ -48,5 +48,4 @@ jobs:
         env:
           JULIA_PKG_SERVER: ""
           {% raw %}GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
-          {% endraw %}
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}{% endraw %}
diff --git a/.github/workflows/Test.yml.jinja b/.github/workflows/Test.yml.jinja
@@ -43,13 +43,13 @@ jobs:
           - x64
         allow_failure: [false]
         {% if RunJuliaNightlyOnCI %}include:
-          - version: 'nightly'
+          - version: "nightly"
             os: ubuntu-latest
             arch: x64
-          {% if not AddMacToCI %}#{% endif %}- version: 'nightly'
+          {% if not AddMacToCI %}#{% endif %}- version: "nightly"
           {% if not AddMacToCI %}#{% endif %}  os: macOS-latest
           {% if not AddMacToCI %}#{% endif %}  arch: x64
-          {% if not AddWinToCI %}#{% endif %}- version: 'nightly'
+          {% if not AddWinToCI %}#{% endif %}- version: "nightly"
           {% if not AddWinToCI %}#{% endif %}  os: windows-latest
           {% if not AddWinToCI %}#{% endif %}  arch: x64{% endif %}
     steps:

diff --git a/README.md b/README.md
@@ -40,7 +40,7 @@ I have done that in the past, but now I want even less manual intervention.
     uuid4()
     ```
 
-4. The resulting folder will not be a `git` package yet (to avoid trust issues), so you need to handle that yourself:
+4. The resulting folder will not be a `git` package yet (to avoid trust issues), so you need to handle that yourself.
 
     ```bash
     cd YourPackage.jl
@@ -125,7 +125,15 @@ Also slightly related, is the `.editorconfig` file, which tells your editor, if
 The select a few workflows, with a strong possibility of expanding in the future:
 
 - CompatHelper.yml: Should be well known by now. It checks that your Project.toml compat entries are up-to-date.
+- Compliance.yml: This will periodically check the template for updates. If there are updates, this action creates a pull request updating your repo.
 - Docs.yml: Build the docs. Only runs when relevant files change.
 - Lint.yml: Run the linter and formatter through the command `pre-commit run -a`.
 - TagBot.yml: Create GitHub releases automatically after your new release is merged on the Registry.
 - Test.yml: Run the tests.
+
+## Users and Examples
+
+The following are users and examples of repos using this template.
+Feel free to create a pull request to add your repo.
+
+_Empty_.
diff --git a/README.md.jinja b/README.md.jinja
@@ -1,5 +1,7 @@
 # {{ PackageName }}
 
+<!-- This check was disabled because these links don't exist until you push, create documentation, and create your first release -->
+<!-- markdown-link-check-disable -->
 [![Stable Documentation](https://img.shields.io/badge/docs-stable-blue.svg)](https://{{ PackageOwner }}.github.io/{{ PackageName }}.jl/stable)
 [![In development documentation](https://img.shields.io/badge/docs-dev-blue.svg)](https://{{ PackageOwner }}.github.io/{{ PackageName }}.jl/dev)
 [![Build Status](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/workflows/Test/badge.svg)](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/actions)