Skip to content

Commit fb536aa

Browse files
authored
Initial commit
0 parents  commit fb536aa

19 files changed

Lines changed: 889 additions & 0 deletions

.cz.toml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
[tool.commitizen]
2+
name = "cz_conventional_commits"
3+
tag_format = "$version"
4+
version_scheme = "semver"
5+
version = "0.0.1"
6+
update_changelog_on_bump = true
7+
major_version_zero = true

.github/CODEOWNERS

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
####################################################
2+
#
3+
# List of approvers for <project-name> project
4+
#
5+
#####################################################
6+
#
7+
# Learn about CODEOWNERS file format:
8+
# https://help.github.com/en/articles/about-code-owners
9+
#
10+
11+
# These owners will be the default owners for everything in
12+
# the repository. Unless a later match takes precedence,
13+
# the following users/teams will be requested for
14+
# review when someone opens a pull request.
15+
* @agntcy/<maintainer-team-name>
16+
17+
# Enforces admin protections for repo configuration via probot settings app.
18+
# ref: https://github.com/probot/settings#security-implications
19+
.github/settings.yml @agntcy/<admin-team-name>
Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
---
2+
name: Bug Report
3+
description: Report a bug to help us improve.
4+
title: "[Bug]: "
5+
labels: ["bug", "triage"]
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for taking the time to fill out this bug report!
11+
- type: textarea
12+
id: description
13+
attributes:
14+
label: Bug Description
15+
description: Please provide a description of the problem
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: expected
20+
attributes:
21+
label: Expected Behavior
22+
description: Please describe what you expected would happen
23+
validations:
24+
required: true
25+
- type: dropdown
26+
id: version
27+
attributes:
28+
label: Affected Version
29+
description: |
30+
If applicable, provide the version number or release tag where this
31+
issue was encountered
32+
options:
33+
- v1.0.0
34+
- v1.0.1
35+
- v1.0.2
36+
- v1.0.3
37+
default: 0
38+
validations:
39+
required: false
40+
- type: textarea
41+
id: steps
42+
attributes:
43+
label: Steps to Reproduce
44+
description: Please provide all steps to reproduce the behavior
45+
placeholder: |
46+
1. In this environment...
47+
1. With this config...
48+
1. Run `this command`...
49+
1. See error...
50+
validations:
51+
required: true
52+
- type: checkboxes
53+
id: checklist
54+
attributes:
55+
label: Checklist
56+
description: By submitting this issue, you agree to the following
57+
options:
58+
- label: I have read the [contributing guidelines](/agntcy/repo-template/blob/main/CONTRIBUTING.md)
59+
required: true
60+
- label: I have verified this does not duplicate an existing issue
61+
required: true
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
name: Feature Request
3+
description: Suggest a feature for this project.
4+
title: "[Feature]: "
5+
labels: ["enhancement", "triage"]
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for taking the time to request a feature or enhancement!
11+
- type: textarea
12+
id: description
13+
attributes:
14+
label: Problem Statement
15+
description: |
16+
Please describe the problem or limitation to be addressed by
17+
the proposed feature
18+
validations:
19+
required: true
20+
- type: textarea
21+
id: solution
22+
attributes:
23+
label: Proposed Solution
24+
description: |
25+
Please describe what you envision the solution to this
26+
problem would look like
27+
validations:
28+
required: true
29+
- type: textarea
30+
id: alternatives
31+
attributes:
32+
label: Alternatives Considered
33+
description: |
34+
Please briefly describe which alternatives, if any, have been
35+
considered, including merits of alternate approaches and any tradeoffs
36+
validations:
37+
required: false
38+
- type: textarea
39+
id: context
40+
attributes:
41+
label: Additional Context
42+
description: Please provide any other information that may be relevant
43+
validations:
44+
required: false
45+
- type: checkboxes
46+
id: checklist
47+
attributes:
48+
label: Checklist
49+
description: By submitting this request, you agree to the following
50+
options:
51+
- label: I have read the [contributing guidelines](/agntcy/repo-template/blob/main/CONTRIBUTING.md)
52+
required: true
53+
- label: |
54+
I have verified this does not duplicate an existing feature request
55+
required: true

.github/dependabot.yml

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

.github/linters/.markdownlint.yml

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
# Default state for all rules
3+
default: true
4+
# Path to configuration file to extend
5+
extends: null
6+
7+
# MD013/line-length
8+
# https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md013.md
9+
MD013:
10+
# Number of characters
11+
line_length: 150
12+
# Include code blocks
13+
code_blocks: true
14+
# Include tables
15+
tables: true
16+
# Include headings
17+
headings: true
18+
# Strict length checking
19+
strict: false
20+
# Stern length checking
21+
stern: false
22+
23+
# MD024/no-duplicate-heading
24+
# https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md024.md
25+
MD024:
26+
# Only check sibling headings
27+
siblings_only: true
28+
29+
# MD025/single-title/single-h1
30+
# https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md025.md
31+
MD025:
32+
# RegExp for matching title in front matter
33+
front_matter_title: ""
34+
35+
# MD041/first-line-heading/first-line-h1
36+
# https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md041.md
37+
MD041:
38+
# RegExp for matching title in front matter
39+
front_matter_title: ""
40+
41+
# MD033/no-inline-html
42+
MD033:
43+
allowed_elements: ['a', 'img', 'alt', 'p']

.github/linters/.yamllint.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
extends: default
3+
4+
rules:
5+
line-length:
6+
max: 120
7+
level: warning
8+
comments: disable
9+
indentation: disable
10+
truthy:
11+
check-keys: false

.github/pull_request_template.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Description
2+
3+
Please provide a meaningful description of what this change will do, or is for.
4+
Bonus points for including links to related issues, other PRs, or technical
5+
references.
6+
7+
Note that by _not_ including a description, you are asking reviewers to do extra
8+
work to understand the context of this change, which may lead to your PR taking
9+
much longer to review, or result in it not being reviewed at all.
10+
11+
## Type of Change
12+
13+
- [ ] Bugfix
14+
- [ ] New Feature
15+
- [ ] Breaking Change
16+
- [ ] Refactor
17+
- [ ] Documentation
18+
- [ ] Other (please describe)
19+
20+
## Checklist
21+
22+
- [ ] I have read the [contributing guidelines](/agntcy/repo-template/blob/main/CONTRIBUTING.md)
23+
- [ ] Existing issues have been referenced (where applicable)
24+
- [ ] I have verified this change is not present in other open pull requests
25+
- [ ] Functionality is documented
26+
- [ ] All code style checks pass
27+
- [ ] New code contribution is covered by automated tests
28+
- [ ] All new and existing tests pass

.github/settings.yml

Lines changed: 119 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
1+
---
2+
# These settings are synced to GitHub by https://probot.github.io/apps/settings/
3+
4+
repository:
5+
# See https://developer.github.com/v3/repos/#edit for all available settings.
6+
7+
# The name of the repository. Changing this will rename the repository
8+
name: repo-template
9+
10+
# A short description of the repository that will show up on GitHub
11+
description: Agntcy Project Repo Template
12+
13+
# A URL with more information about the repository
14+
homepage: https://www.example.com
15+
16+
# A comma-separated list of topics to set on the repository
17+
topics: github, probot
18+
19+
# Either `true` to make the repository private, or `false` to make it public.
20+
private: true
21+
22+
# Either `true` to enable issues for this repository, `false` to disable them.
23+
has_issues: true
24+
25+
# Either `true` to enable projects for this repository, or `false` to disable them.
26+
# If projects are disabled for the organization, passing `true` will cause an API error.
27+
has_projects: true
28+
29+
# Either `true` to enable the wiki for this repository, `false` to disable it.
30+
has_wiki: false
31+
32+
# Either `true` to enable downloads for this repository, `false` to disable them.
33+
has_downloads: true
34+
35+
# Updates the default branch for this repository.
36+
default_branch: main
37+
38+
# Either `true` to allow squash-merging pull requests, or `false` to prevent
39+
# squash-merging.
40+
allow_squash_merge: true
41+
42+
# Either `true` to allow merging pull requests with a merge commit, or `false`
43+
# to prevent merging pull requests with merge commits.
44+
allow_merge_commit: true
45+
46+
# Either `true` to allow rebase-merging pull requests, or `false` to prevent
47+
# rebase-merging.
48+
allow_rebase_merge: true
49+
50+
# Either `true` to enable automatic deletion of branches on merge, or `false` to disable
51+
delete_branch_on_merge: true
52+
53+
# Either `true` to enable automated security fixes, or `false` to disable
54+
# automated security fixes.
55+
enable_automated_security_fixes: true
56+
57+
# Either `true` to enable vulnerability alerts, or `false` to disable
58+
# vulnerability alerts.
59+
enable_vulnerability_alerts: true
60+
61+
# TODO: Enable this section once GitHub teams have been created & granted access to this repository
62+
# See https://developer.github.com/v3/teams/#add-or-update-team-repository for options
63+
# teams:
64+
# # The permission to grant the team. Can be one of:
65+
# # * `pull` - can pull, but not push to or administer this repository.
66+
# # * `push` - can pull and push, but not administer this repository.
67+
# # * `admin` - can pull, push and administer this repository.
68+
# # * `maintain` - Recommended for project managers who need to manage the
69+
# # repository without access to sensitive or destructive actions.
70+
# # * `triage` - Recommended for contributors who need to proactively manage
71+
# # issues and pull requests without write access.
72+
# - name: <project-name-admins>
73+
# permission: admin
74+
# - name: <project-name-maintainers>
75+
# permission: maintain
76+
# - name: <project-name>
77+
# permission: triage
78+
79+
# TODO: Enable this section once repository has been created & no further modifications are needed
80+
# branches:
81+
# - name: main
82+
# # https://developer.github.com/v3/repos/branches/#update-branch-protection
83+
# # Branch Protection settings. Set to null to disable
84+
# protection:
85+
# # Required. Require at least one approving review on a pull request,
86+
# # before merging. Set to null to disable.
87+
# required_pull_request_reviews:
88+
# # The number of approvals required. (1-6)
89+
# required_approving_review_count: 1
90+
# # Dismiss approved reviews automatically when a new commit is pushed.
91+
# dismiss_stale_reviews: true
92+
# # Blocks merge until code owners have reviewed.
93+
# require_code_owner_reviews: true
94+
# # Specify which users and teams can dismiss pull request reviews. Pass
95+
# # an empty dismissal_restrictions object to disable. User and team
96+
# # dismissal_restrictions are only available for organization-owned
97+
# # repositories. Omit this parameter for personal repositories.
98+
# dismissal_restrictions:
99+
# users: []
100+
# teams: []
101+
# # Required. Require status checks to pass before merging. Set to null to disable
102+
# required_status_checks:
103+
# # Required. Require branches to be up to date before merging.
104+
# strict: true
105+
# # Required. The list of required status checks in order to merge into this branch
106+
# contexts: []
107+
# # Required. Enforce all configured restrictions for administrators. Set to
108+
# # true to enforce required status checks for repository administrators.
109+
# # Set to null to disable.
110+
# enforce_admins: true
111+
# # Prevent merge commits from being pushed to matching branches
112+
# required_linear_history: true
113+
# # Required. Restrict who can push to this branch. Team and user
114+
# # restrictions are only available for organization-owned repositories. Set
115+
# # to null to disable.
116+
# restrictions:
117+
# apps: []
118+
# users: []
119+
# teams: []
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
name: commit-msg
3+
4+
on:
5+
push:
6+
# Run superlinter on pushes to default branch
7+
branches:
8+
- main
9+
# Run superlinter on pull request events
10+
pull_request:
11+
12+
# Declare default permissions as read-only
13+
permissions: read-all
14+
15+
jobs:
16+
conventional-commits:
17+
runs-on: ubuntu-latest
18+
permissions:
19+
contents: read
20+
packages: read
21+
statuses: write
22+
steps:
23+
- name: 🔒 harden runner
24+
uses: step-security/harden-runner@4d991eb9b905ef189e4c376166672c3f2f230481 # v2.11.0
25+
with:
26+
egress-policy: audit
27+
- uses: actions/checkout@v4
28+
with:
29+
fetch-depth: 0
30+
- name: 🧹 Conventional Commits
31+
uses: webiny/action-conventional-commits@v1.3.0
32+
with:
33+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

0 commit comments

Comments
 (0)