Skip to content

Commit 1c9feb9

Browse files
committed
feat: initial version
0 parents  commit 1c9feb9

17 files changed

Lines changed: 443 additions & 0 deletions

.github/CODE_OF_CONDUCT.md

Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
- Demonstrating empathy and kindness toward other people
21+
- Being respectful of differing opinions, viewpoints, and experiences
22+
- Giving and gracefully accepting constructive feedback
23+
- Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
- Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
- The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
- Trolling, insulting or derogatory comments, and personal or political attacks
33+
- Public or private harassment
34+
- Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
- Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
contact@dafnik.me.
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Permanent Ban
96+
97+
**Community Impact**: Demonstrating a pattern of violation of community
98+
standards, including sustained inappropriate behavior, harassment of an
99+
individual, or aggression toward or disparagement of classes of individuals.
100+
101+
**Consequence**: A permanent ban from any sort of public interaction within
102+
the community.
103+
104+
## Attribution
105+
106+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
107+
version 2.0, available at
108+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
109+
110+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
111+
enforcement ladder](https://github.com/mozilla/diversity).
112+
113+
[homepage]: https://www.contributor-covenant.org
114+
115+
For answers to common questions about this code of conduct, see the FAQ at
116+
https://www.contributor-covenant.org/faq. Translations are available at
117+
https://www.contributor-covenant.org/translations.

.github/FUNDING.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# These are supported funding model platforms
2+
3+
github: Dafnik
4+
liberapay: Dafnik

.github/SECURITY.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
<!-- prettier-ignore-start -->
6+
| Version | Supported |
7+
|---------|--------------------|
8+
| 1.x.x | :white_check_mark: |
9+
| < 1.0 | :x: |
10+
<!-- prettier-ignore-end -->
11+
12+
## Reporting a Vulnerability
13+
14+
If you believe you've identified a security vulnerability in `notymail` (a bug that allows something to happen that shouldn't be possible), you can reach us at <security@dafnik.me>.
15+
16+
You will receive a response from us within 48 hours. If the issue is confirmed, we will release a patch as soon as possible depending on complexity but likely within a few days.
17+
18+
## Scope
19+
20+
A "vulnerability in notymail" is a vulnerability in the code distributed through our main source code repository on GitHub. Vulnerabilities that are specific to a given installation (e.g. misconfiguration) should be reported to the owner of that installation and not us.

.github/pr-labeler.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
enhancement: ['feature/*']
2+
bug: 'fix/*'
3+
chore: ['chore/*']
4+
documentation: ['docs/*']

.github/release-drafter.yml

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name-template: 'v$RESOLVED_VERSION'
3+
tag-template: 'v$RESOLVED_VERSION'
4+
template: |
5+
# Changelog
6+
7+
$CHANGES
8+
9+
See details of [all code changes](https://github.com/$OWNER/$REPOSITORY/compare/$PREVIOUS_TAG...v$RESOLVED_VERSION) since previous release.
10+
categories:
11+
- title: '🚀 Features'
12+
labels:
13+
- 'enhancement'
14+
- title: '🐛 Bug Fixes'
15+
labels:
16+
- 'bug'
17+
- title: '📖 Docs'
18+
labels:
19+
- 'docs'
20+
- title: '🧰 Maintenance'
21+
labels:
22+
- 'documentation'
23+
- 'chore'
24+
- 'dependencies'
25+
change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
26+
version-resolver:
27+
major:
28+
labels:
29+
- 'breaking'
30+
minor:
31+
labels:
32+
- 'enhancement'
33+
patch:
34+
labels:
35+
- 'bug'
36+
- 'chore'
37+
- 'dependencies'
38+
default: patch

.github/renovate.json

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
{
2+
'$schema': 'https://docs.renovatebot.com/renovate-schema.json',
3+
'baseBranches': ['main'],
4+
'enabledManagers': ['github-actions', 'npm'],
5+
'semanticCommits': 'enabled',
6+
'semanticCommitScope': '',
7+
'semanticCommitType': 'build',
8+
'commitBody': 'See associated pull request for more information.',
9+
'schedule':
10+
[
11+
'after 11:00pm on the 1 day of the month',
12+
'before 4am on the 2 day of the month',
13+
'after 11:00pm on the 15 day of the month',
14+
'before 4am on the 16 day of the month',
15+
],
16+
'timezone': 'Europe/Vienna',
17+
'labels': ['dependencies'],
18+
'assignees': ['Dafnik'],
19+
'packageRules':
20+
[
21+
{
22+
'matchPackagePatterns': ['*'],
23+
'matchUpdateTypes': ['minor', 'patch', 'pin', 'digest'],
24+
'groupName': 'minor-updates',
25+
},
26+
{ 'matchUpdateTypes': ['major'], 'groupName': 'major-update' },
27+
],
28+
'extends':
29+
[
30+
'config:base',
31+
':pinVersions',
32+
':unpublishSafe',
33+
':prNotPending',
34+
':preserveSemverRanges',
35+
':rebaseStalePrs',
36+
],
37+
}

.github/workflows/ci.yml

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
name: CI
2+
3+
on: [pull_request]
4+
5+
jobs:
6+
prettier:
7+
name: Prettier Check
8+
runs-on: ubuntu-latest
9+
steps:
10+
- name: Checkout Repository
11+
uses: actions/checkout@v4
12+
with:
13+
fetch-depth: 0
14+
15+
- name: Run Prettier
16+
id: prettier-run
17+
uses: rutajdash/prettier-cli-action@v1.0.2
18+
with:
19+
config_path: ./.prettierrc.yml
20+
21+
- name: Prettier Output
22+
if: ${{ failure() }}
23+
shell: bash
24+
run: |
25+
echo "The following files are not formatted:"
26+
echo "${{steps.prettier-run.outputs.prettier_output}}"
27+
28+
commitlint:
29+
runs-on: ubuntu-latest
30+
steps:
31+
- uses: actions/checkout@v4
32+
with:
33+
fetch-depth: 0
34+
35+
- uses: dafnik/setup-node-pnpm@v3
36+
with:
37+
install-ignore-scripts: true
38+
39+
- name: Validate current commit (last commit) with commitlint
40+
if: github.event_name == 'push'
41+
run: pnpm exec commitlint --from HEAD~1 --to HEAD --verbose
42+
43+
- name: Validate PR commits with commitlint
44+
if: github.event_name == 'pull_request'
45+
run: pnpm exec commitlint --from ${{ github.event.pull_request.head.sha }}~${{ github.event.pull_request.commits }} --to ${{ github.event.pull_request.head.sha }} --verbose
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: Draft release
2+
on:
3+
push:
4+
branches:
5+
- main
6+
7+
permissions:
8+
contents: read
9+
10+
jobs:
11+
draft-release:
12+
permissions:
13+
# write permission is required to create a github release
14+
contents: write
15+
# write permission is required for autolabeler
16+
# otherwise, read permission is required at least
17+
pull-requests: write
18+
runs-on: ubuntu-latest
19+
steps:
20+
- uses: actions/checkout@v4
21+
- uses: release-drafter/release-drafter@v6
22+
env:
23+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/label-pr.yml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: PR Labeler
2+
on:
3+
pull_request:
4+
types: [opened]
5+
6+
permissions:
7+
contents: read
8+
9+
jobs:
10+
pr-labeler:
11+
permissions:
12+
contents: read # for TimonVS/pr-labeler-action to read config file
13+
pull-requests: write # for TimonVS/pr-labeler-action to add labels in PR
14+
runs-on: ubuntu-latest
15+
steps:
16+
- uses: TimonVS/pr-labeler-action@v5
17+
with:
18+
repo-token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/release.yml

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: Release
2+
on:
3+
release:
4+
types: [released]
5+
workflow_dispatch:
6+
inputs:
7+
TAG_NAME:
8+
description: 'Tag name that the major tag will point to'
9+
required: true
10+
11+
env:
12+
TAG_NAME: ${{ github.event.inputs.TAG_NAME || github.event.release.tag_name }}
13+
14+
permissions:
15+
contents: write
16+
17+
jobs:
18+
update_tag:
19+
name: Update the major tag to include the ${{ github.event.inputs.TAG_NAME || github.event.release.tag_name }} changes
20+
runs-on: ubuntu-latest
21+
environment:
22+
# Note: this environment is protected
23+
name: Release
24+
steps:
25+
- name: Update the ${{ env.TAG_NAME }} tag
26+
id: update-major-tag
27+
uses: actions/publish-action@v0.3.0
28+
with:
29+
source-tag: ${{ env.TAG_NAME }}
30+
slack-webhook: ${{ secrets.SLACK_WEBHOOK }}

0 commit comments

Comments
 (0)