Skip to content

Commit ae3a7f2

Browse files
refactor: improve overall tooling (#37) (#38)
* refactor: improve overall tooling (#37) * refactor: improve overall tooling * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> * chore: remove action-validator hook from pre-commit configuration (#39) --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
1 parent 3c778f4 commit ae3a7f2

30 files changed

+337
-107
lines changed

.editorconfig

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# EditorConfig is awesome: https://editorconfig.org
2+
3+
# top-most EditorConfig file
4+
root = true
5+
6+
# Unix-style newlines with a newline ending every file
7+
[*]
8+
end_of_line = lf
9+
insert_final_newline = true

.github-language-analysis.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
# Github dil analizi için oluşturumluştur.
1+
# Github dil analizi için oluşturulmuştur.

.github/dependabot.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
---
12
version: 2
23
updates:
34
- package-ecosystem: "pip"

.github/workflows/build-docs.yml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
name: Build Docs
3+
on:
4+
workflow_dispatch: # Allows manual triggering of the workflow
5+
push:
6+
branches: ["main"] # Triggers on pushes to the main branch
7+
pull_request:
8+
branches: ["main"] # Triggers on pull requests targeting the main branch
9+
jobs:
10+
deploy:
11+
runs-on: ubuntu-latest
12+
timeout-minutes: 10
13+
steps:
14+
# Step 1: Check out the repository
15+
# Description: Checks out the repository so that the workflow can access its contents.
16+
- name: Checkout repository
17+
uses: actions/checkout@v4
18+
# Step 2: Install mise using the specified action
19+
# Description: Installs mise, along with the tools defined in the mise.toml file.
20+
- name: Install mise
21+
uses: jdx/mise-action@v2
22+
# Step 3: Build the documentation
23+
# Description: Runs the style:lint, style:format, and docs:build commands using mise.
24+
- name: Build docs
25+
run: mise run docs:build

.github/workflows/deploy-docs.yml

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
name: Deploy Docs
3+
on:
4+
workflow_dispatch: # Allows manual triggering of the workflow
5+
release:
6+
types: [published] # Trigger on release publication
7+
concurrency:
8+
group: ${{ github.workflow }}-${{ github.ref }} # Grouping by workflow name and reference
9+
cancel-in-progress: true # Cancel any in-progress runs for the same group
10+
permissions:
11+
contents: write # Required for pushing changes to the repository
12+
jobs:
13+
deploy:
14+
runs-on: ubuntu-latest
15+
timeout-minutes: 10
16+
steps:
17+
# Step 1: Check out the repository
18+
# Description: Checks out the repository so that the workflow can access its contents.
19+
- name: Checkout repository
20+
uses: actions/checkout@v4
21+
# Step 2: Install mise using the specified action
22+
# Description: Installs mise, a tool for building and deploying documentation, along
23+
# with the tools defined in the mise.toml file.
24+
- name: Install mise
25+
uses: jdx/mise-action@v2
26+
# Step 3: Build and deploy the documentation
27+
# Description: Builds the documentation using mkdocs and pushes it to the gh-pages branch.
28+
- name: Build and deploy docs
29+
run: mkdocs gh-deploy --force

.github/workflows/enforcer.yml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
name: "Check Branch"
3+
on:
4+
pull_request:
5+
branches: ['main'] # Trigger on pull requests to the 'main' branch
6+
jobs:
7+
check_branch:
8+
runs-on: ubuntu-latest
9+
steps:
10+
- name: Check if branch is valid
11+
# Use a conditional to ensure the base branch is 'main' and the head branch is not 'dev'
12+
if: ${{ github.base_ref == 'main' && github.head_ref != 'dev' }}
13+
run: |
14+
echo "ERROR: You can only merge to 'main' from 'dev'."
15+
exit 1

.github/workflows/gh-pages.yml

Lines changed: 0 additions & 42 deletions
This file was deleted.

.github/workflows/pages.yml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
1-
# Inspired by [fastapi/.github/workflows/people.yml at master · tiangolo/fastapi](https://github.com/tiangolo/fastapi/blob/master/.github/workflows/people.yml)
1+
---
2+
# [Based on](https://github.com/tiangolo/fastapi/blob/master/.github/workflows/people.yml)
23
name: FastAPI Pages
3-
44
on:
55
schedule:
66
- cron: "0 0 1 1 *" # Update it as "0 1 * * *" to run it every day at 01:00 UTC
7-
87
jobs:
98
fastapi-pages:
109
if: github.repository_owner == 'hasansezertasan'

.gitignore

Lines changed: 110 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,63 @@
1+
### Generated by gibo (https://github.com/simonwhitaker/gibo)
2+
### https://raw.github.com/github/gitignore/297239c101dcfdfae7e75757ed17ed993df0b4eb/Global/macOS.gitignore
3+
4+
# General
5+
.DS_Store
6+
.AppleDouble
7+
.LSOverride
8+
9+
# Icon must end with two \r
10+
Icon
11+
12+
13+
# Thumbnails
14+
._*
15+
16+
# Files that might appear in the root of a volume
17+
.DocumentRevisions-V100
18+
.fseventsd
19+
.Spotlight-V100
20+
.TemporaryItems
21+
.Trashes
22+
.VolumeIcon.icns
23+
.com.apple.timemachine.donotpresent
24+
25+
# Directories potentially created on remote AFP share
26+
.AppleDB
27+
.AppleDesktop
28+
Network Trash Folder
29+
Temporary Items
30+
.apdisk
31+
### Generated by gibo (https://github.com/simonwhitaker/gibo)
32+
### https://raw.github.com/github/gitignore/297239c101dcfdfae7e75757ed17ed993df0b4eb/Global/Windows.gitignore
33+
34+
# Windows thumbnail cache files
35+
Thumbs.db
36+
Thumbs.db:encryptable
37+
ehthumbs.db
38+
ehthumbs_vista.db
39+
40+
# Dump file
41+
*.stackdump
42+
43+
# Folder config file
44+
[Dd]esktop.ini
45+
46+
# Recycle Bin used on file shares
47+
$RECYCLE.BIN/
48+
49+
# Windows Installer files
50+
*.cab
51+
*.msi
52+
*.msix
53+
*.msm
54+
*.msp
55+
56+
# Windows shortcuts
57+
*.lnk
58+
### Generated by gibo (https://github.com/simonwhitaker/gibo)
59+
### https://raw.github.com/github/gitignore/297239c101dcfdfae7e75757ed17ed993df0b4eb/Python.gitignore
60+
161
# Byte-compiled / optimized / DLL files
262
__pycache__/
363
*.py[cod]
@@ -94,20 +154,28 @@ ipython_config.py
94154
# install all needed dependencies.
95155
#Pipfile.lock
96156

157+
# UV
158+
# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
159+
# This is especially recommended for binary packages to ensure reproducibility, and is more
160+
# commonly ignored for libraries.
161+
#uv.lock
162+
97163
# poetry
98164
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
99165
# This is especially recommended for binary packages to ensure reproducibility, and is more
100166
# commonly ignored for libraries.
101167
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
102-
poetry.lock
168+
#poetry.lock
103169

104170
# pdm
105171
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
106172
#pdm.lock
107173
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
108174
# in version control.
109-
# https://pdm.fming.dev/#use-with-ide
175+
# https://pdm.fming.dev/latest/usage/project/#working-with-version-control
110176
.pdm.toml
177+
.pdm-python
178+
.pdm-build/
111179

112180
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
113181
__pypackages__/
@@ -159,8 +227,44 @@ cython_debug/
159227
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
160228
#.idea/
161229

162-
# Visual Studio Code related
163-
.vscode
230+
# Ruff stuff:
231+
.ruff_cache/
164232

165-
# Generated by MacOS
166-
.DS_Store
233+
# PyPI configuration file
234+
.pypirc
235+
### Generated by gibo (https://github.com/simonwhitaker/gibo)
236+
### https://raw.github.com/github/gitignore/297239c101dcfdfae7e75757ed17ed993df0b4eb/GitHubPages.gitignore
237+
238+
# This .gitignore is appropriate for repositories deployed to GitHub Pages and using
239+
# a Gemfile as specified at https://github.com/github/pages-gem#conventional
240+
241+
# Basic Jekyll gitignores (synchronize to Jekyll.gitignore)
242+
_site/
243+
.sass-cache/
244+
.jekyll-cache/
245+
.jekyll-metadata
246+
247+
# Additional Ruby/bundler ignore for when you run: bundle install
248+
/vendor
249+
250+
# Specific ignore for GitHub Pages
251+
# GitHub Pages will always use its own deployed version of pages-gem
252+
# This means GitHub Pages will NOT use your Gemfile.lock and therefore it is
253+
# counterproductive to check this file into the repository.
254+
# Details at https://github.com/github/pages-gem/issues/768
255+
Gemfile.lock
256+
### Generated by gibo (https://github.com/simonwhitaker/gibo)
257+
### https://raw.github.com/github/gitignore/297239c101dcfdfae7e75757ed17ed993df0b4eb/Global/VisualStudioCode.gitignore
258+
259+
.vscode/*
260+
!.vscode/settings.json
261+
!.vscode/tasks.json
262+
!.vscode/launch.json
263+
!.vscode/extensions.json
264+
!.vscode/*.code-snippets
265+
266+
# Local History for Visual Studio Code
267+
.history/
268+
269+
# Built Visual Studio Code Extensions
270+
*.vsix

.markdownlint-cli2.jsonc

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"config": {
3+
"default": true,
4+
"MD013": false
5+
},
6+
"fix": true,
7+
"globs": [
8+
"**/*.md",
9+
"**/*.markdown"
10+
],
11+
"gitignore": true
12+
}

0 commit comments

Comments
 (0)