Skip to content

Commit 9fb8809

Browse files
hopeyenhopeyen
committed
refactor: repo meta-documentations
1 parent 12c7ef1 commit 9fb8809

12 files changed

+544
-112
lines changed

‎.auto-changelog

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"output": "changelog.md",
3+
"template": "keepachangelog",
4+
"unreleased": true,
5+
"commitLimit": false,
6+
"commitMessageFormat": "{{type}}: {{message}}"
7+
}

‎.github/ISSUE_TEMPLATE/bug_report.md

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Desktop (please complete the following information):**
27+
- OS: [e.g. iOS]
28+
- Version [e.g. 22]
29+
- Rust Version [e.g. 22]
30+
- Other Versionings [e.g. 22]
31+
32+
**Additional context**
33+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: "[Feat.Req]"
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Problem statement**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Expectation proposal**
14+
A clear and concise description of what you want to happen.
15+
16+
**Alternative considerations**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

‎.github/workflows/docker.yml

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: Build and upload Docker image
2+
3+
on:
4+
release:
5+
types: [published]
6+
push:
7+
tags:
8+
- "*.*.*"
9+
10+
env:
11+
REGISTRY: ghcr.io
12+
BASE_NAME: graphops/indexer-service-rs
13+
14+
jobs:
15+
build-linux:
16+
runs-on: ubuntu-latest
17+
18+
steps:
19+
- name: Checkout
20+
uses: actions/checkout@v3
21+
22+
- name: Docker meta
23+
id: meta
24+
uses: docker/metadata-action@v4
25+
with:
26+
# list of Docker images to use as base name for tags
27+
images: |
28+
${{ env.REGISTRY }}/${{ env.BASE_NAME }}
29+
# generate Docker tags based on the following events/attributes
30+
tags: |
31+
type=schedule
32+
type=ref,event=branch
33+
type=ref,event=pr
34+
type=semver,pattern={{version}}
35+
type=semver,pattern={{major}}.{{minor}}
36+
type=semver,pattern={{major}}.{{minor}}.{{patch}}
37+
type=semver,pattern={{major}}
38+
type=sha
39+
latest:main
40+
latest:dev
41+
42+
- name: Log in to the Container registry
43+
uses: docker/login-action@465a07811f14bebb1938fbed4728c6a1ff8901fc
44+
with:
45+
registry: ${{ env.REGISTRY }}
46+
username: ${{ github.actor }}
47+
password: ${{ secrets.DOCKER_TOKEN }}
48+
49+
- name: Build and push
50+
uses: docker/build-push-action@v4
51+
with:
52+
context: ./
53+
push: ${{ github.event_name != 'pull_request' }}
54+
tags: ${{ steps.meta.outputs.tags }}
55+
dockerfile: Dockerfile

‎.github/workflows/gen-binaries.yml

+61
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
name: Build and upload release binaries
2+
3+
on:
4+
release:
5+
types: [published]
6+
7+
jobs:
8+
build-linux:
9+
runs-on: ubuntu-latest
10+
11+
steps:
12+
- uses: actions/checkout@v3
13+
- name: Setup Rust
14+
uses: actions-rs/toolchain@v1
15+
with:
16+
toolchain: stable
17+
- name: Install Go
18+
run: |
19+
if [ $(uname -m) = "aarch64" ]; then
20+
wget https://golang.org/dl/go1.19.5.linux-arm64.tar.gz &&
21+
sudo tar -C /usr/local -xzf go1.19.5.linux-arm64.tar.gz
22+
else
23+
wget https://golang.org/dl/go1.19.5.linux-amd64.tar.gz &&
24+
sudo tar -C /usr/local -xzf go1.19.5.linux-amd64.tar.gz
25+
fi
26+
export PATH=$PATH:/usr/local/go/bin
27+
- name: Build release binary
28+
run: |
29+
cargo build --release
30+
- name: Upload Ubuntu binary
31+
uses: actions/[email protected]
32+
env:
33+
GITHUB_TOKEN: ${{ secrets.RELEASE_TOKEN }}
34+
with:
35+
upload_url: ${{ github.event.release.upload_url }}
36+
asset_path: ./target/release/indexer-service-rs
37+
asset_name: indexer-service-rs-${{ github.event.release.tag_name }}-ubuntu
38+
asset_content_type: binary/octet-stream
39+
build-macos:
40+
runs-on: macos-latest
41+
steps:
42+
- uses: actions/checkout@v3
43+
- name: Setup Rust
44+
uses: actions-rs/toolchain@v1
45+
with:
46+
toolchain: stable
47+
- uses: actions/setup-go@v4
48+
with:
49+
go-version: "1.19.5"
50+
- name: Build release binary
51+
run: |
52+
cargo build --release
53+
- name: Upload MacOS binary
54+
uses: actions/[email protected]
55+
env:
56+
GITHUB_TOKEN: ${{ secrets.RELEASE_TOKEN }}
57+
with:
58+
upload_url: ${{ github.event.release.upload_url }}
59+
asset_path: ./target/release/indexer-service-rs
60+
asset_name: indexer-service-rs-${{ github.event.release.tag_name }}-macos
61+
asset_content_type: binary/octet-stream

‎.github/workflows/release.yml

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
changelog:
2+
exclude:
3+
labels:
4+
- ignore-for-release
5+
authors:
6+
- octocat
7+
categories:
8+
- title: Breaking Changes 🛠
9+
labels:
10+
- Semver-Major
11+
- breaking-change
12+
- title: Features 🏕
13+
labels:
14+
- Semver-Minor
15+
- feat
16+
- enhancement
17+
exclude:
18+
labels:
19+
- dependencies
20+
- chore
21+
- title: Dependencies 👒
22+
labels:
23+
- dependencies
24+
- chore
25+
- title: Bug fixes 🐛
26+
labels:
27+
- bug
28+
- title: Refactor 🌱
29+
labels:
30+
- refactor
31+
- title: Other Changes 🗳️
32+
labels:
33+
- "*"

‎CODE_OF_CONDUCT.md

+128
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
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+
[email protected].
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. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120+
121+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122+
enforcement ladder](https://github.com/mozilla/diversity).
123+
124+
[homepage]: https://www.contributor-covenant.org
125+
126+
For answers to common questions about this code of conduct, see the FAQ at
127+
https://www.contributor-covenant.org/faq. Translations are available at
128+
https://www.contributor-covenant.org/translations.

‎contributing.md renamed to ‎CONTRIBUTORS.md

File renamed without changes.

0 commit comments

Comments
 (0)