Skip to content

Commit 4877bdf

Browse files
MuntasirSZNMuntasirSZN
committed
chore: add important files
1 parent 09e2972 commit 4877bdf

17 files changed

Lines changed: 741 additions & 25 deletions

‎.chglog/CHANGELOG.tpl.md‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
{{ if .Versions -}}
2+
<a name="unreleased"></a>
3+
## [Unreleased]
4+
5+
{{ if .Unreleased.CommitGroups -}}
6+
{{ range .Unreleased.CommitGroups -}}
7+
### {{ .Title }}
8+
{{ range .Commits -}}
9+
- {{ if .Scope }}**{{ .Scope }}:** {{ end }}{{ .Subject }}
10+
{{ end }}
11+
{{ end -}}
12+
{{ end -}}
13+
{{ end -}}
14+
15+
{{ range .Versions }}
16+
<a name="{{ .Tag.Name }}"></a>
17+
## {{ if .Tag.Previous }}[{{ .Tag.Name }}]{{ else }}{{ .Tag.Name }}{{ end }} - {{ datetime "2006-01-02" .Tag.Date }}
18+
{{ range .CommitGroups -}}
19+
### {{ .Title }}
20+
{{ range .Commits -}}
21+
- {{ if .Scope }}**{{ .Scope }}:** {{ end }}{{ .Subject }}
22+
{{ end }}
23+
{{ end -}}
24+
25+
{{- if .RevertCommits -}}
26+
### Reverts
27+
{{ range .RevertCommits -}}
28+
- {{ .Revert.Header }}
29+
{{ end }}
30+
{{ end -}}
31+
32+
{{- if .MergeCommits -}}
33+
### Pull Requests
34+
{{ range .MergeCommits -}}
35+
- {{ .Header }}
36+
{{ end }}
37+
{{ end -}}
38+
39+
{{- if .NoteGroups -}}
40+
{{ range .NoteGroups -}}
41+
### {{ .Title }}
42+
{{ range .Notes }}
43+
{{ .Body }}
44+
{{ end }}
45+
{{ end -}}
46+
{{ end -}}
47+
{{ end -}}
48+
49+
{{- if .Versions }}
50+
[Unreleased]: {{ .Info.RepositoryURL }}/compare/{{ $latest := index .Versions 0 }}{{ $latest.Tag.Name }}...HEAD
51+
{{ range .Versions -}}
52+
{{ if .Tag.Previous -}}
53+
[{{ .Tag.Name }}]: {{ $.Info.RepositoryURL }}/compare/{{ .Tag.Previous.Name }}...{{ .Tag.Name }}
54+
{{ end -}}
55+
{{ end -}}
56+
{{ end -}}

‎.chglog/config.yml‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
style: github
2+
template: CHANGELOG.tpl.md
3+
info:
4+
title: CHANGELOG
5+
repository_url: https://github.com/cordx56/rustowl
6+
options:
7+
commits:
8+
filters:
9+
Type:
10+
- feat
11+
- fix
12+
- perf
13+
- refactor
14+
- chore
15+
commit_groups:
16+
title_maps:
17+
feat: 🚀 Features
18+
fix: 🐞 Bug Fixes
19+
perf: ⚡ Performance Improvements
20+
refactor: ♻️ Code Refactoring
21+
chore: 🎨 Chores
22+
header:
23+
pattern: "^(\\w*)(?:\\(([\\w\\$\\.\\-\\*\\s]*)\\))?\\:\\s(.*)$"
24+
pattern_maps:
25+
- Type
26+
- Scope
27+
- Subject
28+
notes:
29+
keywords:
30+
- 🚨 Breaking Changes

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: Bug report
2+
description: Report a bug to help us improve Rou3-rs
3+
labels: bug
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thank you for reporting a bug!
9+
10+
Before submitting, please search existing issues to avoid duplicates. If a similar issue exists, comment there instead of opening a new one.
11+
12+
To help us resolve the issue efficiently, please provide the necessary details below.
13+
14+
- type: textarea
15+
id: bug-description
16+
attributes:
17+
label: Bug Description
18+
description: Describe the issue you encountered.
19+
placeholder: Provide a clear and concise description of the problem, including what you expected to happen and what actually occurred.
20+
validations:
21+
required: true
22+
23+
- type: textarea
24+
id: environment
25+
attributes:
26+
label: Environment
27+
description: Provide details about your setup.
28+
placeholder: |
29+
- Rou3 Version: [e.g., v0.1.1]
30+
validations:
31+
required: true

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: true

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: Feature request
2+
description: Suggest an idea for Rou3-rs
3+
labels: enhancement
4+
body:
5+
- type: textarea
6+
attributes:
7+
label: What is the problem you're trying to solve
8+
description: |
9+
A clear and concise description of what the problem is.
10+
validations:
11+
required: true
12+
13+
- type: textarea
14+
attributes:
15+
label: Describe the solution you'd like
16+
description: |
17+
A clear and concise description of what you'd like to happen.
18+
validations:
19+
required: true
20+
21+
- type: textarea
22+
attributes:
23+
label: Additional context
24+
description: |
25+
Add any other context about the feature request here.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
## Related Issue(s)
2+
3+
<!--
4+
If this PR fixes any issues, please link to the issue here.
5+
- Fixes #<issue_number>
6+
-->
7+
8+
## Description
9+
10+
<!-- Describe the big picture of your changes to communicate to the maintainers
11+
why we should accept this pull request. -->

‎.github/dependabot.yml‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: cargo
4+
directory: "/"
5+
schedule:
6+
interval: "daily"
7+
- package-ecosystem: github-actions
8+
directory: "/"
9+
schedule:
10+
interval: "daily"

‎.github/workflows/lint.yml‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: ✅ Lint Code
2+
3+
on:
4+
push:
5+
branches: [ "main" ]
6+
pull_request:
7+
branches:
8+
- main
9+
schedule:
10+
- cron: '19 4 * * 2'
11+
workflow_call:
12+
13+
jobs:
14+
lint:
15+
runs-on: ubuntu-latest
16+
permissions:
17+
security-events: write
18+
steps:
19+
# Checkout the repository
20+
- name: 🛠️ Checkout code
21+
uses: actions/checkout@v4
22+
23+
# Set up Rust toolchain
24+
- name: 🦀 Set up Rust toolchain
25+
uses: actions-rs/toolchain@v1
26+
with:
27+
profile: minimal
28+
toolchain: stable
29+
components: clippy, rustfmt
30+
override: true
31+
32+
# Cache Rust dependencies
33+
- name: 📦 Cache Rust dependencies
34+
uses: Swatinem/rust-cache@v1
35+
36+
# Install clippy-sarif and sarif-fmt
37+
- name: ⬇️ Install clippy-sarif and sarif-fmt
38+
run: cargo install clippy-sarif sarif-fmt
39+
40+
# Run clippy and generate SARIF report
41+
- name: 🔍 Run Clippy and generate SARIF
42+
run: |
43+
cargo clippy --all-targets --all-features --message-format=json |
44+
clippy-sarif | tee results.sarif | sarif-fmt
45+
46+
# Upload SARIF file
47+
- name: 📤 Upload SARIF file
48+
uses: github/codeql-action/upload-sarif@v3
49+
with:
50+
sarif_file: results.sarif

‎.github/workflows/release-please.yml‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
on:
2+
push:
3+
branches:
4+
- main
5+
6+
permissions:
7+
contents: write
8+
pull-requests: write
9+
10+
name: release-please
11+
12+
jobs:
13+
release-please:
14+
runs-on: ubuntu-latest
15+
steps:
16+
- uses: googleapis/release-please-action@v4
17+
id: release
18+
with:
19+
token: ${{ secrets.MY_RELEASE_PLEASE_TOKEN }}
20+
release-type: rust
21+
- uses: actions/checkout@v4
22+
with:
23+
fetch-depth: 0
24+
if: ${{ steps.release.outputs.release_created }}
25+
- name: Setup Node
26+
uses: actions/setup-node@v4
27+
if: ${{ steps.release.outputs.release_created }}
28+
with:
29+
registry-url: https://registry.npmjs.org/
30+
node-version: lts/*
31+
- name: Install Rust toolchain
32+
uses: dtolnay/rust-toolchain@stable
33+
if: ${{ steps.release.outputs.release_created }}
34+
with:
35+
components: clippy,rustfmt
36+
- name: Create Release Notes
37+
if: ${{ steps.release.outputs.release_created }}
38+
run: npx changelogithub
39+
env:
40+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
41+
- name: Publish To Crates.io
42+
if: ${{ steps.release.outputs.release_created }}
43+
run: cargo publish --token ${{ secrets.CRATES_IO_TOKEN }} --allow-dirty
44+
env:
45+
CRATES_IO_TOKEN: ${{ secrets.CRATES_IO_TOKEN }}

‎.github/workflows/stale.yml‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: 📌 Mark stale issues and pull requests
2+
3+
on:
4+
schedule:
5+
- cron: '0 7 * * *'
6+
7+
jobs:
8+
mark-stale:
9+
10+
runs-on: ubuntu-latest
11+
permissions:
12+
issues: write
13+
pull-requests: write
14+
15+
steps:
16+
- uses: actions/stale@v5
17+
with:
18+
repo-token: ${{ secrets.GITHUB_TOKEN }}
19+
stale-issue-message: '🤖 Bot: **Issue** has not seen activity in **30** days and will therefore be marked as stale. It will be closed in 7 days if no further response is found.'
20+
stale-pr-message: '🤖 Bot: **PR** has not seen activity in **30** days and will therefore be marked as stale. It will be closed in 7 days if no further response is found.'
21+
stale-issue-label: 'no-issue-activity'
22+
stale-pr-label: 'no-pr-activity'
23+
days-before-stale: 30

0 commit comments

Comments
 (0)