Skip to content

Commit

Permalink
Update template change minimum to recommended
Browse files Browse the repository at this point in the history
  • Loading branch information
abelsiqueira committed Jun 11, 2024
1 parent 39c4780 commit 7de4e42
Show file tree
Hide file tree
Showing 17 changed files with 467 additions and 28 deletions.
5 changes: 5 additions & 0 deletions .all-contributorsrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"projectName": "TulipaIO",
"projectOwner": "TulipaEnergy",
"files": ["README.md", "docs/src/index.md"]
}
2 changes: 1 addition & 1 deletion .copier-answers.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Changes here will be overwritten by Copier
AnswerStrategy: minimum
AnswerStrategy: recommended
AuthorEmail: [email protected]
AuthorName: Suvayu Ali
Indentation: 4
Expand Down
61 changes: 61 additions & 0 deletions .github/ISSUE_TEMPLATE/10-bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
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/TulipaEnergy/TulipaIO.jl/issues) with the same question
- You have read the [contributing guide](https://github.com/TulipaEnergy/TulipaIO.jl/blob/main/docs/src/90-contributing.md/)
- You are following the [code of conduct](https://github.com/TulipaEnergy/TulipaIO.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?
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
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/20-feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
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 bug report!
Please, before submitting, make sure that:
- There is not an [existing issue](https://github.com/TulipaEnergy/TulipaIO.jl/issues) with the same question
- You have read the [contributing guide](https://github.com/TulipaEnergy/TulipaIO.jl/blob/main/docs/src/90-contributing.md/)
- You are following the [code of conduct](https://github.com/TulipaEnergy/TulipaIO.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: 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?
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/30-usage.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
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 bug report!
Please, before submitting, make sure that:
- You have checked the [documentation](https://TulipaEnergy.github.io/TulipaIO.jl) and haven't found enough information
- There is not an [existing issue](https://github.com/TulipaEnergy/TulipaIO.jl/issues) with the same question
- You have read the [contributing guide](https://github.com/TulipaEnergy/TulipaIO.jl/blob/main/docs/src/90-contributing.md/)
- You are following the [code of conduct](https://github.com/TulipaEnergy/TulipaIO.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
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/99-general.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
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 bug report!
Please, before submitting, make sure that:
- There is not an [existing issue](https://github.com/TulipaEnergy/TulipaIO.jl/issues) with the same question
- You have read the [contributing guide](https://github.com/TulipaEnergy/TulipaIO.jl/blob/main/docs/src/90-contributing.md/)
- You are following the [code of conduct](https://github.com/TulipaEnergy/TulipaIO.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/TulipaEnergy/TulipaIO.jl/discussions
about: Create and follow discussions here
28 changes: 28 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<!--
Thanks for making a pull request to TulipaIO.jl.
We have added this PR template to help you help us.
Make sure to read the contributing guidelines and abide to 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/TulipaEnergy/TulipaIO.jl/blob/main/docs/src/90-contributing.md)
- [ ] Tests are passing
- [ ] Lint workflow is passing
- [ ] Docs were updated and workflow is passing
<!-- - [ ] [CHANGELOG.md](https://github.com/TulipaEnergy/TulipaIO.jl/blob/main/CHANGELOG.md) was updated -->
27 changes: 23 additions & 4 deletions .github/workflows/Lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,18 +19,37 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Clone
uses: actions/checkout@v3
uses: actions/checkout@v4
- name: Setup Julia
uses: julia-actions/setup-julia@v1
uses: julia-actions/setup-julia@v2
with:
version: "1"
- name: Use Julia cache
uses: julia-actions/cache@v1
uses: julia-actions/cache@v2
- name: Install JuliaFormatter.jl
run: julia -e 'using Pkg; pkg"add JuliaFormatter"'
- name: Setup Python
uses: actions/setup-python@v4
uses: actions/setup-python@v5
with:
cache: "pip"
- 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
35 changes: 35 additions & 0 deletions .github/workflows/PreCommitUpdate.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: pre-commit Update

on:
schedule:
- cron: "0 7 1/7 * *" # At 7:00 every 7 days
workflow_dispatch:

jobs:
pre-commit-update:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Setup Python
uses: actions/setup-python@v5
with:
cache: pip
- name: Install pre-commit
run: pip install pre-commit
- name: Run pre-commit's autoupdate
run: |
# ignore exit code
pre-commit autoupdate || true
- name: Create Pull Request
id: cpr
uses: peter-evans/create-pull-request@v6
with:
commit-message: "chore: :robot: pre-commit update"
title: "[AUTO] pre-commit update"
branch: auto-pre-commit-update
delete-branch: true
labels: chore
- name: Check outputs
run: |
echo "Pull Request Number - ${{ steps.cpr.outputs.pull-request-number }}"
echo "Pull Request URL - ${{ steps.cpr.outputs.pull-request-url }}"
13 changes: 3 additions & 10 deletions .github/workflows/Test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,7 @@ on:
branches:
- main
tags: ["*"]
pull_request:
branches:
- main
paths:
- "src/**"
- "test/**"
- "*.toml"
types: [opened, synchronize, reopened]

workflow_dispatch:

jobs:
Expand All @@ -34,8 +27,8 @@ jobs:
- "1"
os:
- ubuntu-latest
#- macOS-latest
#- windows-latest
- macOS-latest
- windows-latest
arch:
- x64
allow_failure: [false]
29 changes: 29 additions & 0 deletions .github/workflows/TestOnPRs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Test on PRs

on:
pull_request:
branches:
- main
paths:
- "src/**"
- "test/**"
- "*.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:
test:
uses: ./.github/workflows/ReusableTest.yml
with:
os: ubuntu-latest
version: "1"
arch: x64
allow_failure: false
run_codecov: true
secrets:
codecov_token: ${{ secrets.CODECOV_TOKEN }}
16 changes: 5 additions & 11 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ repos:
language: fail
files: "\\.rej$"
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.4.0
rev: v4.6.0
hooks:
- id: check-json
- id: check-toml
Expand All @@ -26,30 +26,24 @@ repos:
- id: check-merge-conflict
args: [--assume-in-merge]
- repo: https://github.com/igorshubovych/markdownlint-cli
rev: v0.37.0
rev: v0.41.0
hooks:
- id: markdownlint-fix
- repo: https://github.com/citation-file-format/cffconvert
rev: 054bda51dbe278b3e86f27c890e3f3ac877d616c
hooks:
- id: validate-cff
- repo: https://github.com/pre-commit/mirrors-prettier
rev: "v3.0.3" # Use the sha or tag you want to point at
rev: "v4.0.0-alpha.8" # Use the sha or tag you want to point at
hooks:
- id: prettier
types_or: [yaml, json]
exclude: ".copier-answers.yml"
- repo: https://github.com/adrienverge/yamllint
rev: v1.32.0
rev: v1.35.1
hooks:
- id: yamllint
- repo: https://github.com/domluna/JuliaFormatter.jl
rev: v1.0.36
rev: v1.0.56
hooks:
- id: julia-formatter
- repo: https://github.com/tcort/markdown-link-check
rev: v3.11.2
hooks:
- id: markdown-link-check
args:
- --config=.markdown-link-config.json
Loading

0 comments on commit 7de4e42

Please sign in to comment.