Skip to content

Commit

Permalink
[add] Code Formatter in Git hooks
Browse files Browse the repository at this point in the history
[add] GitHub repository settings & PR badges
[fix] missing script in fetching PDF action
  • Loading branch information
TechQuery committed Jun 25, 2024
1 parent 77b2efa commit 4453038
Show file tree
Hide file tree
Showing 7 changed files with 451 additions and 5 deletions.
17 changes: 17 additions & 0 deletions .github/pr-badge.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
- icon: visualstudio
label: "GitHub.dev"
message: "PR-$prNumber"
color: "blue"
url: "https://github.dev/$owner/$repo/pull/$prNumber"

- icon: github
label: "GitHub codespaces"
message: "PR-$prNumber"
color: "black"
url: "https://codespaces.new/$owner/$repo/pull/$prNumber"

- icon: git
label: "GitPod.io"
message: "PR-$prNumber"
color: "orange"
url: "https://gitpod.io/?autostart=true#https://github.com/$owner/$repo/pull/$prNumber"
85 changes: 85 additions & 0 deletions .github/settings.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
# These settings are synced to GitHub by https://probot.github.io/apps/settings/

repository:
allow_merge_commit: false

delete_branch_on_merge: true

enable_vulnerability_alerts: true

labels:
- name: bug
color: "#d73a4a"
description: Something isn't working

- name: documentation
color: "#0075ca"
description: Improvements or additions to documentation

- name: duplicate
color: "#cfd3d7"
description: This issue or pull request already exists

- name: enhancement
color: "#a2eeef"
description: Some improvements

- name: feature
color: "#16b33f"
description: New feature or request

- name: good first issue
color: "#7057ff"
description: Good for newcomers

- name: help wanted
color: "#008672"
description: Extra attention is needed

- name: invalid
color: "#e4e669"
description: This doesn't seem right

- name: question
color: "#d876e3"
description: Further information is requested

- name: wontfix
color: "#ffffff"
description: This will not be worked on

branches:
- name: main
# https://docs.github.com/en/rest/reference/repos#update-branch-protection
protection:
# Required. Require at least one approving review on a pull request, before merging. Set to null to disable.
required_pull_request_reviews:
# The number of approvals required. (1-6)
required_approving_review_count: 1
# Dismiss approved reviews automatically when a new commit is pushed.
dismiss_stale_reviews: true
# Blocks merge until code owners have reviewed.
require_code_owner_reviews: true
# Specify which users and teams can dismiss pull request reviews.
# Pass an empty dismissal_restrictions object to disable.
# User and team dismissal_restrictions are only available for organization-owned repositories.
# Omit this parameter for personal repositories.
dismissal_restrictions:
# users: []
# teams: []
# Required. Require status checks to pass before merging. Set to null to disable
required_status_checks:
# Required. Require branches to be up to date before merging.
strict: true
# Required. The list of status checks to require in order to merge into this branch
contexts: []
# Required. Enforce all configured restrictions for administrators.
# Set to true to enforce required status checks for repository administrators.
# Set to null to disable.
enforce_admins: true
# Prevent merge commits from being pushed to matching branches
required_linear_history: true
# Required. Restrict who can push to this branch.
# Team and user restrictions are only available for organization-owned repositories.
# Set to null to disable.
restrictions: null
17 changes: 15 additions & 2 deletions .github/workflows/fetch-PDF.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,22 @@ jobs:
Download-and-Transform:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v3

- run: tool/fetch-PDF.sh data downloads
- uses: pnpm/action-setup@v2
with:
version: 9
- uses: actions/setup-node@v3
with:
node-version: 18
cache: pnpm
- name: Install, Inject & Run
run: |
pnpm i
cat > .env <<EOF
${{ secrets.ENV_FILE }}
EOF
find downloads/ -type f | xargs -I {} pnpm tool {}
- uses: actions/upload-artifact@v4
with:
Expand Down
1 change: 1 addition & 0 deletions .husky/pre-commit
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
npm test
1 change: 1 addition & 0 deletions .husky/pre-push
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
npm run build
10 changes: 9 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,19 @@
"devDependencies": {
"@parcel/config-default": "~2.12.0",
"@types/node": "^18.19.38",
"husky": "^9.0.11",
"lint-staged": "^15.2.7",
"parcel": "~2.12.0",
"parcel-transformer-mdx": "^0.3.2"
"parcel-transformer-mdx": "^0.3.2",
"prettier": "^3.3.2"
},
"lint-staged": {
"*.{html,md,css,less,json,yml,js,ts,tsx}": "prettier --write"
},
"scripts": {
"prepare": "husky",
"install": "cp -n .env.example .env",
"test": "lint-staged",
"clean": "rm -rf .parcel-cache/ dist/",
"start": "npm run clean && parcel src/index.html",
"build": "npm run clean && parcel build src/index.html --public-url .",
Expand Down
Loading

0 comments on commit 4453038

Please sign in to comment.