Skip to content

Commit

Permalink
Hello, World.
Browse files Browse the repository at this point in the history
  • Loading branch information
denschub committed Jun 8, 2024
0 parents commit 4302074
Show file tree
Hide file tree
Showing 36 changed files with 3,718 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
DATABASE_URL=postgres://[email protected]/vssv
LISTEN_URL=[::1]:3000
83 changes: 83 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our community include:

- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
- Focusing on what is best not just for us as individuals, but for the overall community

Examples of unacceptable behavior include:

- The use of sexualized language or imagery, and sexual attention or advances of any kind
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email address, without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.

Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement via eMail to [email protected]. All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series of actions.

**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within the community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].

Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][mozilla coc].

For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][faq]. Translations are available at [https://www.contributor-covenant.org/translations][translations].

[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[mozilla coc]: https://github.com/mozilla/diversity
[faq]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations
13 changes: 13 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Contributing

Whoop! Whoop! Thanks for reading this! I welcome your contribution!

## Non-code contributions

All contributions matter. You don't have to be an experienced programmer to contribute to this project. Every single issue filed, any question asked, and all improvements to the documentation is welcome!

## Code contributions

For smaller changes that do not affect the applications behavior in a breaking way, like bugfixes, refactoring, and similar things: please feel free to submit a Pull Request!

For larger changes that have an effect on this applications behavior and might even break existing setups, please open an issue first so we can have a chance to discuss about your plans first.
9 changes: 9 additions & 0 deletions .github/SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Security Policy

## Supported Versions

Only the latest version of this application is supported.

## Reporting a Vulnerability

Please send an email to [mail@dennis-schubert](mailto:mail@dennis-schubert) or reach out to me on Matrix to [@denschub:schub.social](https://matrix.to/#/@denschub:schub.social) to privately report a vulnerability.
12 changes: 12 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
version: 2
updates:
- package-ecosystem: github-actions
directory: /
schedule:
interval: weekly

- package-ecosystem: cargo
directory: /
schedule:
interval: weekly
open-pull-requests-limit: 100
37 changes: 37 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: build

on:
push:
branches:
- develop
- release

env:
CARGO_TERM_COLOR: always

jobs:
build:
runs-on: ubuntu-20.04
env:
AWS_LC_SYS_CMAKE_BUILDER: true
steps:
- uses: actions/checkout@v4
- name: Update system
run: sudo apt-get update && sudo apt-get install -y cmake
- name: Update Rust
run: rustup update stable
- name: Build release artifacts
run: cargo install --locked --path . --root ./out
# https://github.com/actions/upload-artifact/issues/38 is still not fixed.
- name: Package the binary
run: |
cd out/bin/
zip vssv.zip vssv
- name: Get the built version number
id: version_number
run: echo "version=$(out/bin/vssv --version | awk -F ' ' '{print $2}')" >> $GITHUB_OUTPUT
- name: Upload release artifacts
uses: actions/upload-artifact@v4
with:
name: vssv-${{ steps.version_number.outputs.version }}-linux-amd64
path: out/bin/vssv.zip
33 changes: 33 additions & 0 deletions .github/workflows/docker-develop.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: docker-develop

on:
push:
branches:
- develop

jobs:
publish:
runs-on: ubuntu-20.04
permissions:
packages: write
steps:
- uses: actions/checkout@v4
- name: Login to DockerHub
uses: docker/login-action@v3
with:
username: ${{ vars.DOCKERHUB_USER }}
password: ${{ secrets.DOCKERHUB_TOKEN }}
- name: Login to GitHub Container Registry
uses: docker/login-action@v3
with:
registry: ghcr.io
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
- name: Build and push
uses: docker/build-push-action@v5
with:
context: .
push: true
tags: |
ghcr.io/${{ github.repository }}:develop,
${{ github.repository }}:develop
45 changes: 45 additions & 0 deletions .github/workflows/docker-release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: docker-release

on:
release:
types:
- published

jobs:
publish:
runs-on: ubuntu-20.04
permissions:
packages: write
steps:
- uses: actions/checkout@v4
- name: Split tag name into semver-compatible subsections
id: version_numbers
run: |
echo "patch=$(echo $GITHUB_REF | sed 's=refs/tags/v==g')" >> $GITHUB_OUTPUT
echo "minor=$(echo $GITHUB_REF | sed 's=refs/tags/v==g' | cut -d "." -f 1,2)" >> $GITHUB_OUTPUT
echo "major=$(echo $GITHUB_REF | sed 's=refs/tags/v==g' | cut -d "." -f 1)" >> $GITHUB_OUTPUT
- name: Login to DockerHub
uses: docker/login-action@v3
with:
username: ${{ vars.DOCKERHUB_USER }}
password: ${{ secrets.DOCKERHUB_TOKEN }}
- name: Login to GitHub Container Registry
uses: docker/login-action@v3
with:
registry: ghcr.io
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
- name: Build and push
uses: docker/build-push-action@v5
with:
context: .
push: true
tags: |
ghcr.io/${{ github.repository }}:latest,
ghcr.io/${{ github.repository }}:${{ steps.version_numbers.outputs.patch }},
ghcr.io/${{ github.repository }}:${{ steps.version_numbers.outputs.minor }},
ghcr.io/${{ github.repository }}:${{ steps.version_numbers.outputs.major }},
${{ github.repository }}:latest,
${{ github.repository }}:${{ steps.version_numbers.outputs.patch }},
${{ github.repository }}:${{ steps.version_numbers.outputs.minor }},
${{ github.repository }}:${{ steps.version_numbers.outputs.major }}
43 changes: 43 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: tests

on:
push:
branches:
- develop
- release
pull_request:
types:
- opened
- synchronize
- reopened

env:
CARGO_TERM_COLOR: always

jobs:
test:
runs-on: ubuntu-20.04
steps:
- uses: actions/checkout@v4
- name: Update Rust
run: rustup update stable
- name: cargo test
run: cargo test

rustfmt:
runs-on: ubuntu-20.04
steps:
- uses: actions/checkout@v4
- name: Update Rust
run: rustup update stable
- name: cargo fmt
run: cargo fmt --all -- --check

clippy:
runs-on: ubuntu-20.04
steps:
- uses: actions/checkout@v4
- name: Update Rust
run: rustup update stable
- name: cargo clippy
run: cargo clippy -- -D warnings
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.env
target/

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 4302074

Please sign in to comment.