Skip to content

Commit

Permalink
Open-source the runner
Browse files Browse the repository at this point in the history
  • Loading branch information
nikola-jokic committed Dec 6, 2024
0 parents commit 2b29223
Show file tree
Hide file tree
Showing 60 changed files with 7,557 additions and 0 deletions.
55 changes: 55 additions & 0 deletions .github/ISSUE_TEMPLATE/1-bug-template.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
name: Runner Bug Report
description: Create a bug report.
labels: ["bug", "needs triage", "platform"]
assignees: ["nikola-jokic"]
body:
- type: checkboxes
id: checks
attributes:
label: Check the following before submitting a bug report
description: |
Please check the following before submitting a bug report.
options:
- label: I have searched the issues of this repository and believe that this is not a duplicate
required: true
- label: I have read the docs and I'm sure this is a bug
required: true
- label: This is not a security issue
required: true
- label: I will make sure sensitive information is not shared in this public repository
required: true

- type: textarea
id: description
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is.
placeholder: A clear and concise description of what the bug is.
render: markdown
validations:
required: true
- type: textarea
id: reproduction
attributes:
label: To Reproduce
description: Steps to reproduce the behavior.
placeholder: Steps to reproduce the behavior.
render: markdown
validations:
required: true
- type: textarea
id: expected
attributes:
label: Expected behavior
description: A clear and concise description of what you expected to happen.
placeholder: A clear and concise description of what you expected to happen.
render: markdown
validations:
required: true
- type: textarea
id: screenshots
attributes:
label: Screenshots
render: markdown
description: If applicable, add screenshots to help explain your problem.
placeholder: If applicable, add screenshots to help explain your problem.
39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/2-feature-template.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: "Runner Feature Request"
description: "Create a feature request"
labels: ["enhancement", "needs triage", "platform"]
assignees: ["nikola-jokic"]
body:
- type: checkboxes
id: checks
attributes:
label: Check the following before submitting a feature request
options:
- label: I have searched the issues of this repository and believe that this is not a duplicate
required: true
- label: I have read the docs and I'm sure this is a feature request
required: true
- type: textarea
id: description
attributes:
label: Describe the feature
description: A clear and concise description of what the feature is.
placeholder: A clear and concise description of what the feature is.
render: markdown
validations:
required: true
- type: textarea
id: motivation
attributes:
label: Motivation
description: A clear and concise description of why you need this feature.
placeholder: A clear and concise description of why you need this feature.
render: markdown
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Alternatives
description: A clear and concise description of any alternative solutions or features you've considered.
placeholder: A clear and concise description of any alternative solutions or features you've considered.
render: markdown
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Platform Bugs/Features
url: https://github.com/bountyhub-org/platform
about: Please report any bugs or features you find on the platform here.
20 changes: 20 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: CI

on:
push:
branches: ["main"]
pull_request:
branches: ["main"]

env:
CARGO_TERM_COLOR: always

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Build
run: cargo build --verbose
- name: Run tests
run: cargo test --verbose
110 changes: 110 additions & 0 deletions .github/workflows/release.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
name: "Release"

on:
push:
tags:
- "[0-9]+.[0-9]+.[0-9]+"

permissions:
contents: write

jobs:
create-release:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Get the release version from the tag
run: echo "VERSION=${{ github.ref_name }}" >> $GITHUB_ENV
- name: Check that tag version and cli Cargo.toml version match
run: |
if ! grep -q "version = \"$VERSION\"" ./crates/cli/Cargo.toml; then
echo "Tag version $VERSION does not match Cargo.toml version" >&2
exit 1
fi
- name: Create GitHub release
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: gh release create $VERSION --draft --verify-tag --title $VERSION
outputs:
version: ${{ env.VERSION }}

build-release:
needs:
- create-release
strategy:
fail-fast: false
matrix:
include:
- target: x86_64-unknown-linux-gnu
os: ubuntu-latest
rust: stable

runs-on: ${{ matrix.os }}
steps:
- uses: actions/checkout@v4

- name: Install rust
uses: dtolnay/rust-toolchain@master
with:
toolchain: stable
target: ${{ matrix.target }}

- name: Build release
run: |
cargo build --release -p cli --verbose --target ${{ matrix.target }}
RELEASE_DIR="target/${{ matrix.target }}/release"
mv "${RELEASE_DIR}/cli" "${RELEASE_DIR}/runner"
echo "BIN=$RELEASE_DIR/runner" >> $GITHUB_ENV
- name: Set archive name
run: |
version="${{ needs.create-release.outputs.version }}"
echo "ARCHIVE=runner-$version-${{ matrix.target }}" >> $GITHUB_ENV
- name: Create archive directory
run: |
echo "Creating archive: $ARCHIVE"
mkdir -p "$ARCHIVE"
cp "$BIN" "$ARCHIVE"/
cp LICENSE "$ARCHIVE"/
ls -la "$ARCHIVE"/
- name: Archive release
run: |
tar -czf "$ARCHIVE".tar.gz "$ARCHIVE"
shasum -a 256 "$ARCHIVE".tar.gz > "$ARCHIVE".tar.gz.sha256
echo "ASSET=$ARCHIVE.tar.gz" >> $GITHUB_ENV
echo "ASSET_SUM=$ARCHIVE.tar.gz.sha256" >> $GITHUB_ENV
- name: Upload release
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
version="${{ needs.create-release.outputs.version }}"
gh release upload "$version" "$ASSET" "$ASSET_SUM"
docker-release:
needs:
- build-release
- create-release
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: docker/login-action@v3
with:
username: ${{ secrets.DOCKER_USERNAME }}
password: ${{ secrets.DOCKER_PASSWORD }}
- name: "Prepare environment"
run: |
echo "IMAGE_TAG=${{ needs.create-release.outputs.version }}" >> $GITHUB_ENV
echo "IMAGE_NAME=bountyhuborg/runner" >> $GITHUB_ENV
echo "BUILD_PLATFORMS=linux/amd64" >> $GITHUB_ENV
- name: Build image
env:
DOCKER_BUILDKIT: 1
run: |
docker buildx build --platform="${BUILD_PLATFORMS}" \
-f images/Dockerfile \
-t "${IMAGE_NAME}:${IMAGE_TAG}" \
. --push
shell: bash
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
/target
.runner
.vscode
_work
132 changes: 132 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
# 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 email 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 at
[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
Loading

0 comments on commit 2b29223

Please sign in to comment.