Skip to content

Commit

Permalink
Apply BestieTemplate v0.13.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Cmurilochem committed Oct 18, 2024
1 parent d08b67d commit 39e9ae2
Show file tree
Hide file tree
Showing 66 changed files with 87,321 additions and 85,990 deletions.
3 changes: 3 additions & 0 deletions .JuliaFormatter.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
indent = 4
margin = 92
normalize_line_endings = "unix"
5 changes: 5 additions & 0 deletions .all-contributorsrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"projectName": "GalerkinToolkit",
"projectOwner": "GalerkinToolkit",
"files": ["README.md", "docs/src/index.md"]
}
13 changes: 13 additions & 0 deletions .copier-answers.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Changes here will be overwritten by Copier
AnswerStrategy: recommended
Authors: Francesc Verdugo <[email protected]> and contributors
CodeOfConductContact: [email protected]
JuliaIndentation: 4
JuliaMinVersion: '1.10'
License: MIT
LicenseCopyrightHolders: Francesc Verdugo
PackageName: GalerkinToolkit
PackageOwner: GalerkinToolkit
PackageUUID: 5e3ba9c4-dd81-444d-b69a-0e7bd7bf60a4
_commit: v0.13.0
_src_path: https://github.com/JuliaBesties/BestieTemplate.jl
18 changes: 18 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# https://editorconfig.org
root = true

[*]
end_of_line = lf
insert_final_newline = true
charset = utf-8
indent_style = space
trim_trailing_whitespace = true

[*.jl]
indent_size = 4

[*.md]
indent_size = 2

[*.{yml,toml,json}]
indent_size = 2
60 changes: 60 additions & 0 deletions .github/ISSUE_TEMPLATE/10-bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
name: Bug Report
description: File a bug report related to running the package
title: "[Bug] "
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
Please, before submitting, make sure that:
- There is not an [existing issue](https://github.com/GalerkinToolkit/GalerkinToolkit.jl/issues) with the same question
- You have read the [contributing guide](https://GalerkinToolkit.github.io/GalerkinToolkit.jl/dev/90-contributing/)
- You are following the [code of conduct](https://github.com/GalerkinToolkit/GalerkinToolkit.jl/blob/main/CODE_OF_CONDUCT.md)
The form below should help you in filling out this issue.
- type: textarea
id: description
attributes:
label: Description
description: Describe the bug
validations:
required: true
- type: input
id: pkg-version
attributes:
label: Package Version
description: What version of the package are you running?
validations:
required: true
- type: input
id: version
attributes:
label: Julia Version
description: What version of Julia are you running?
validations:
required: true
- type: textarea
id: reproduction
attributes:
label: Reproduction steps
description: What steps led to the bug happening? Please provide a minimal reproducible example.
validations:
required: true
- type: textarea
id: logs
attributes:
label: Relevant log output
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: shell
- type: dropdown
id: os
attributes:
label: "Operating System"
description: What is the impacted environment?
multiple: true
options:
- Windows
- Linux
- Mac
41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/20-feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: "Feature Request"
description: Suggest a new feature for the package
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this feature request!
Please, before submitting, make sure that:
- There is not an [existing issue](https://github.com/GalerkinToolkit/GalerkinToolkit.jl/issues) with the same question
- You have read the [contributing guide](https://GalerkinToolkit.github.io/GalerkinToolkit.jl/dev/90-contributing/)
- You are following the [code of conduct](https://github.com/GalerkinToolkit/GalerkinToolkit.jl/blob/main/CODE_OF_CONDUCT.md)
The form below should help you in filling out this issue.
- type: textarea
id: description
attributes:
label: Description
description: Describe the requested feature
validations:
required: true
- type: textarea
id: validation
attributes:
label: Validation and testing
description: How could we verify that the new feature works? What kind of tests can be done?
- type: textarea
id: motivation
attributes:
label: Motivation
description: Explain why this feature is relevant
- type: textarea
id: target
attributes:
label: Target audience
description: Tell more about the users of this feature, or where it could be useful
- type: textarea
id: can-help
attributes:
label: Can you help?
description: Can you help developing this feature?
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/30-usage.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: "Usage question"
description: Questions related to the usage
labels: ["documentation"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this question!
Please, before submitting, make sure that:
- You have checked the [documentation](https://GalerkinToolkit.github.io/GalerkinToolkit.jl) and haven't found enough information
- There is not an [existing issue](https://github.com/GalerkinToolkit/GalerkinToolkit.jl/issues) with the same question
- You have read the [contributing guide](https://GalerkinToolkit.github.io/GalerkinToolkit.jl/dev/90-contributing/)
- You are following the [code of conduct](https://github.com/GalerkinToolkit/GalerkinToolkit.jl/blob/main/CODE_OF_CONDUCT.md)
The form below should help you in filling out this issue.
- type: textarea
id: description
attributes:
label: Description
description: Write your question
validations:
required: true
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/99-general.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: "General issue"
description: In case none of the others templates apply
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this issue!
Please, before submitting, make sure that:
- There is not an [existing issue](https://github.com/GalerkinToolkit/GalerkinToolkit.jl/issues) with the same question
- You have read the [contributing guide](https://GalerkinToolkit.github.io/GalerkinToolkit.jl/dev/90-contributing/)
- You are following the [code of conduct](https://github.com/GalerkinToolkit/GalerkinToolkit.jl/blob/main/CODE_OF_CONDUCT.md)
The form below should help you in filling out this issue.
- type: textarea
id: description
attributes:
label: Description
description: Describe the issue
validations:
required: true
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Discussions
url: https://github.com/GalerkinToolkit/GalerkinToolkit.jl/discussions
about: Create and follow discussions here
27 changes: 27 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<!--
Thanks for making a pull request to GalerkinToolkit.jl.
We have added this PR template to help you help us.
Make sure to read the contributing guidelines and abide by the code of conduct.
See the comments below, fill the required fields, and check the items.
-->

## Related issues

<!-- We normally work with (i) create issue; (ii) discussion if necessary; (iii) create PR. So, at least one of the following should be true:-->

<!-- Option 1, this closes an existing issue. Fill the number below-->
Closes #

<!-- Option 2, this is a small fix that arguably won't need an issue. Uncomment below -->
<!--
There is no related issue.
-->

## Checklist

<!-- mark true if NA -->
<!-- leave PR as draft until all is checked -->
- [ ] I am following the [contributing guidelines](https://github.com/GalerkinToolkit/GalerkinToolkit.jl/blob/main/docs/src/90-contributing.md)
- [ ] Tests are passing
- [ ] Lint workflow is passing
- [ ] Docs were updated and workflow is passing
7 changes: 7 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
version: 2
updates:
- package-ecosystem: "github-actions"
directory: "/" # Location of package manifests
schedule:
interval: "weekly"
10 changes: 5 additions & 5 deletions .github/workflows/CI.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ on:
push:
branches:
- main
tags: '*'
tags: "*"
pull_request:
concurrency:
# Skip intermediate builds: always.
Expand All @@ -18,7 +18,7 @@ jobs:
fail-fast: false
matrix:
version:
- '1.10'
- "1.10"
os:
- ubuntu-latest
arch:
Expand All @@ -45,7 +45,7 @@ jobs:
fail-fast: false
matrix:
version:
- '1.10'
- "1.10"
os:
- ubuntu-latest
arch:
Expand All @@ -69,7 +69,7 @@ jobs:
runs-on: ubuntu-latest
needs: [test, examples]
steps:
- name: All test jobs have been successful
- name: All test jobs have been successful
run: |
echo "All test jobs have been successful"
Expand All @@ -82,7 +82,7 @@ jobs:
- uses: actions/checkout@v2
- uses: julia-actions/setup-julia@v1
with:
version: '1'
version: "1"
- uses: julia-actions/julia-buildpkg@v1
- uses: julia-actions/julia-docdeploy@v1
env:
Expand Down
57 changes: 57 additions & 0 deletions .github/workflows/Docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
name: Docs

on:
push:
branches:
- main
paths:
- "docs/**"
- "src/**"
- "*.toml"
tags: ["*"]
pull_request:
branches:
- main
paths:
- "docs/**"
- "src/**"
- "*.toml"
types: [opened, synchronize, reopened]

concurrency:
# Skip intermediate builds: always.
# Cancel intermediate builds: only if it is a pull request build.
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}

jobs:
docs:
name: Documentation
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: julia-actions/setup-julia@v2
with:
version: "1"
- name: Use Julia cache
uses: julia-actions/cache@v2
- name: Instantiate environment with development version of the package
run: |
julia --project=docs -e '
using Pkg
Pkg.develop(PackageSpec(path=pwd()))
Pkg.instantiate()'
- name: Run doctest
run: |
julia --project=docs -e '
using Documenter: DocMeta, doctest
using GalerkinToolkit
DocMeta.setdocmeta!(GalerkinToolkit, :DocTestSetup, :(using GalerkinToolkit); recursive=true)
doctest(GalerkinToolkit)'
- name: Generate and deploy documentation
run: julia --project=docs docs/make.jl
env:
JULIA_PKG_SERVER: ""
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
GKSwstype: "100" # https://discourse.julialang.org/t/generation-of-documentation-fails-qt-qpa-xcb-could-not-connect-to-display/60988
60 changes: 60 additions & 0 deletions .github/workflows/Lint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
name: Lint

on:
push:
branches:
- main
tags: ["*"]
pull_request:

concurrency:
# Skip intermediate builds: always.
# Cancel intermediate builds: only if it is a pull request build.
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}

jobs:
lint:
name: Linting
runs-on: ubuntu-latest
steps:
- name: Clone
uses: actions/checkout@v4
- name: Setup Julia
uses: julia-actions/setup-julia@v2
with:
version: "1"
- name: Use Julia cache
uses: julia-actions/cache@v2
- name: Install JuliaFormatter.jl
run: julia -e 'using Pkg; pkg"add JuliaFormatter"'
- name: Hack for setup-python cache # https://github.com/actions/setup-python/issues/807
run: touch requirements.txt
- name: Setup Python
uses: actions/setup-python@v5
with:
cache: "pip"
python-version: "3.11"
- name: Hack for setup-python cache # https://github.com/actions/setup-python/issues/807
run: rm requirements.txt
- name: Cache pre-commit
uses: actions/cache@v4
with:
path: ~/.cache/pre-commit
key: ${{ runner.os }}-pre-commit-${{ hashFiles('**/.pre-commit-config.yaml') }}
- name: Install pre-commit
run: pip install pre-commit
- name: Run pre-commit
run: SKIP=no-commit-to-branch pre-commit run -a
link-checker:
name: Link checker
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- name: Link Checker
id: lychee
uses: lycheeverse/lychee-action@v1
with:
fail: true
args: --config '.lychee.toml' .
Loading

0 comments on commit 39e9ae2

Please sign in to comment.