diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 0000000..84d2c6b --- /dev/null +++ b/.dockerignore @@ -0,0 +1,10 @@ +# all start with .(dot), including directories and files +.* +CHANGELOG.md +CODE_OF_CONDUCT.md +compose.yml +CONTRIBUTING.md +Dockerfile +LICENSE* +README.md +SECURITY.md diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..3501d01 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,14 @@ +root = true + +[*] +charset = utf-8 +end_of_line = lf +indent_size = 4 +indent_style = space +insert_final_newline = true +max_line_length = 120 +tab_width = 4 +trim_trailing_whitespace = true + +[Makefile] +indent_style = tab diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..57de070 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,44 @@ +--- +name: Bug report +about: Create a report to help us improve +title: 'bug: ' +labels: bug +assignees: '' + +--- + +## Bug description + + + +- Would you like to work on a fix? [y/n] + +## To Reproduce + +Steps to reproduce the behavior: + +1. ... +2. ... +3. ... +4. ... + + + +## Expected behavior + + + +## Screenshots + + + +## Environment + + + +- OS: [e.g. Ubuntu 20.04] +- example_rs version: [e.g. 0.1.0] + +## Additional context + + diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..0086358 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..9b061bb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,28 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: 'Feature Request: ' +labels: enhancement +assignees: '' + +--- + +## Motivations + + + +- Would you like to implement this feature? [y/n] + +## Solution + + + +## Alternatives + + + +## Additional context + + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..f089d1d --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,9 @@ + + + diff --git a/.github/configs/labeler.yml b/.github/configs/labeler.yml new file mode 100644 index 0000000..f4ed978 --- /dev/null +++ b/.github/configs/labeler.yml @@ -0,0 +1,63 @@ +version: 1 + +labels: + # Type: Build-related changes + - label: "@type/build" + title: '^build(?:\(.+\))?\!?:' + + # Type: CI-related changes + - label: "@type/ci" + title: '^ci(?:\(.+\))?\!?:' + files: + - '\.github/.+' + + # Type: Documentation changes + - label: "@type/docs" + title: '^docs(?:\(.+\))?\!?:' + files: + - "docs/.+" + - "**/*.md" + + # Type: New feature + - label: "@type/feature" + title: '^feat(?:\(.+\))?\!?:' + + # Type: Bug fix + - label: "@type/fix" + title: '^fix(?:\(.+\))?\!?:' + + # Type: Improvements such as style changes, refactoring, or performance improvements + - label: "@type/improve" + title: '^(style|refactor|perf)(?:\(.+\))?\!?:' + + # Type: Dependency changes + - label: "@type/dependency" + title: '^(chore|build)(?:\(deps\))?\!?:' + + # Type: Test-related changes + - label: "@type/test" + title: '^test(?:\(.+\))?\!?:' + files: + - "tests/.+" + - "spec/.+" + + # Type: Security-related changes + - label: "@type/security" + title: '^security(?:\(.+\))?\!?:' + files: + - "**/security/.+" + + # Issue Type Only: Feature Request + - label: "Feature Request" + type: issue + title: "^Feature Request:" + + # Issue Type Only: Documentation + - label: "Documentation" + type: issue + title: "^.*(\b[Dd]ocumentation|doc(s)?\b).*" + + # Issue Type Only: Bug Report + - label: "Bug Report" + type: issue + title: "^.*(\b[Bb]ug|b(u)?g(s)?\b).*" diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..c44b6f1 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,8 @@ +version: 2 +updates: + - package-ecosystem: "github-actions" + directory: "/" + # Check for updates every Monday + schedule: + interval: "weekly" + open-pull-requests-limit: 10 diff --git a/.github/renovate.json b/.github/renovate.json new file mode 100644 index 0000000..f9c2c32 --- /dev/null +++ b/.github/renovate.json @@ -0,0 +1,6 @@ +{ + "$schema": "https://docs.renovatebot.com/renovate-schema.json", + "extends": [ + "config:base" + ] +} diff --git a/.github/workflows/cd.yml b/.github/workflows/cd.yml new file mode 100644 index 0000000..fd801ff --- /dev/null +++ b/.github/workflows/cd.yml @@ -0,0 +1,82 @@ +name: CD # Continuous Deployment + +on: + push: + tags: + - '[v]?[0-9]+.[0-9]+.[0-9]+' + +jobs: + publish: + name: Publishing for ${{ matrix.job.os }} + runs-on: ${{ matrix.job.os }} + strategy: + matrix: + rust: [ stable ] + job: + - { os: macos-latest, target: x86_64-apple-darwin, architecture: x86_64, binary-postfix: "", use-cross: false } + - { os: macos-latest, target: aarch64-apple-darwin, architecture: arm64, binary-postfix: "", use-cross: false } + - { os: ubuntu-latest, target: x86_64-unknown-linux-gnu, architecture: x86_64, binary-postfix: "", use-cross: false } + - { os: windows-latest, target: x86_64-pc-windows-msvc, architecture: x86_64, binary-postfix: ".exe", use-cross: false } + - { os: ubuntu-latest, target: aarch64-unknown-linux-gnu, architecture: arm64, binary-postfix: "", use-cross: true } + - { os: ubuntu-latest, target: i686-unknown-linux-gnu, architecture: i686, binary-postfix: "", use-cross: true } + + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - name: Install Rust toolchain + uses: actions-rs/toolchain@v1 + with: + toolchain: ${{ matrix.rust }} + target: ${{ matrix.job.target }} + profile: minimal + override: true + + - uses: Swatinem/rust-cache@v2 + + - name: Build Cargo package + uses: actions-rs/cargo@v1 + with: + command: build + use-cross: ${{ matrix.job.use-cross }} + toolchain: ${{ matrix.rust }} + args: --release --target ${{ matrix.job.target }} + + - name: Install strip command (if needed) + if: startsWith(matrix.job.target, 'aarch64') + run: sudo apt-get install -y binutils-aarch64-linux-gnu + + - name: Package final binary + run: | + cd target/${{ matrix.job.target }}/release + BINARY_NAME=example-rs${{ matrix.job.binary-postfix }} + GCC_PREFIX=$( [ "${{ matrix.job.target }}" == "aarch64-unknown-linux-gnu" ] && echo "aarch64-linux-gnu-" || echo "" ) + "$GCC_PREFIX"strip $BINARY_NAME + + RELEASE_NAME=example-rs-${GITHUB_REF/refs\/tags\//}-${{ matrix.job.os-name }}-${{ matrix.job.architecture }} + tar czvf $RELEASE_NAME.tar.gz $BINARY_NAME + shasum -a 256 $RELEASE_NAME.tar.gz > $RELEASE_NAME.sha256 + + - name: Release assets + uses: softprops/action-gh-release@v1 + with: + files: | + target/${{ matrix.job.target }}/release/example-rs-*.tar.gz + target/${{ matrix.job.target }}/release/example-rs-*.sha256 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + publish-cargo: + name: Publishing to Cargo + runs-on: ubuntu-latest + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - name: Install Rust toolchain + uses: dtolnay/rust-toolchain@stable + + - uses: Swatinem/rust-cache@v2 + + - run: cargo publish + env: + CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }} diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..171e40f --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,37 @@ +name: CI # Continuous Integration + +on: + push: + branches: + - main + pull_request: + workflow_dispatch: + +jobs: + ci: + runs-on: ubuntu-latest + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - name: Install Rust toolchain + uses: dtolnay/rust-toolchain@stable + with: + components: rustfmt, clippy + + - name: Cache Rust dependencies + uses: Swatinem/rust-cache@v2 + + - name: Run tests + run: cargo test --all-features --workspace + + - name: Check formatting + run: cargo fmt --all --check + + - name: Clippy check + run: cargo clippy --all-targets --all-features --workspace -- -D warnings + + - name: Check documentation + env: + RUSTDOCFLAGS: -D warnings + run: cargo doc --no-deps --document-private-items --all-features --workspace --examples diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml new file mode 100644 index 0000000..d2d954b --- /dev/null +++ b/.github/workflows/docker.yml @@ -0,0 +1,54 @@ +name: Build and Push Docker Image + +on: + push: + tags: + - '^v[0-9]+\.[0-9]+\.[0-9]+.*$' + +jobs: + docker: + runs-on: ubuntu-latest + steps: + - + name: Checkout + uses: actions/checkout@v4 + - + name: Acquire tag name + run: echo "RELEASE_VERSION=${GITHUB_REF_NAME#refs/*/}" >> $GITHUB_ENV + - + name: Set up QEMU + uses: docker/setup-qemu-action@v3 + - + name: Set up Docker Buildx + uses: docker/setup-buildx-action@v3 + - + name: Login to GitHub Container Registry + uses: docker/login-action@v3 + with: + registry: ghcr.io + username: ${{ github.repository_owner }} + password: ${{ secrets.GITHUB_TOKEN }} + - + name: Build and Export to Docker + uses: docker/build-push-action@v6 + with: + context: . + load: true + tags: | + ghcr.io/x-pt/example-rs:latest + ghcr.io/x-pt/example-rs:${GITHUB_REF_NAME:1} + - + name: Test it before Push + run: | + docker run --rm ghcr.io/x-pt/example-rs:latest + docker run --rm ghcr.io/x-pt/example-rs:${GITHUB_REF_NAME:1} + - + name: Build and Push + uses: docker/build-push-action@v6 + with: + context: . + platforms: linux/amd64,linux/arm64 + push: true + tags: | + ghcr.io/x-pt/example-rs:latest + ghcr.io/x-pt/example-rs:${GITHUB_REF_NAME:1} diff --git a/.github/workflows/labeler.yml b/.github/workflows/labeler.yml new file mode 100644 index 0000000..91499a4 --- /dev/null +++ b/.github/workflows/labeler.yml @@ -0,0 +1,15 @@ +name: Labeler + +on: + - pull_request + - issues + +jobs: + labeler: + runs-on: ubuntu-latest + steps: + - uses: srvaroa/labeler@master + with: + config_path: .github/configs/labeler.yml + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..5254c83 --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,60 @@ +name: Example Rs Release + +on: + push: + tags: + - "v*.*.*" + +jobs: + changelog: + runs-on: ubuntu-latest + steps: + - name: Checkout Code + uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: Get Tag Version + id: tag_version + run: echo "CURRENT_TAG=${GITHUB_REF#refs/tags/}" >> $GITHUB_ENV + + - name: Generate Full Changelog + uses: orhun/git-cliff-action@v4 + with: + config: cliff.toml + args: --verbose + env: + OUTPUT: CHANGELOG.md + GITHUB_REPO: ${{ github.repository }} + + - name: Commit Changelog + run: | + git config user.name 'github-actions[bot]' + git config user.email 'github-actions[bot]@users.noreply.github.com' + set +e + git switch main + git add CHANGELOG.md + git commit -m "chore(release-bot): prepare for release notes on ${CURRENT_TAG}" + git push + + release: + runs-on: ubuntu-latest + steps: + - name: Checkout Code + uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: Generate Latest Release Notes + id: latest_release_notes + uses: orhun/git-cliff-action@v4 + with: + config: cliff.toml + args: --latest --strip all + env: + OUTPUT: CHANGELOG.txt + + - name: Create GitHub Release + uses: softprops/action-gh-release@v2 + with: + body_path: CHANGELOG.txt diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..639c4f9 --- /dev/null +++ b/.gitignore @@ -0,0 +1,19 @@ +### Custom +.idea +.vscode +.DS_Store + +# Generated by Cargo +# will have compiled files and executables +debug/ +target/ + +# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries +# More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html +Cargo.lock + +# These are backup files generated by rustfmt +**/*.rs.bk + +# MSVC Windows builds of rustc generate these, which store debugging information +*.pdb diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..f535b38 --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,23 @@ +fail_fast: true + +repos: + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.6.0 + hooks: + - id: check-merge-conflict + - id: check-toml + - id: check-yaml + - id: end-of-file-fixer + - id: mixed-line-ending + args: [ --fix=lf ] + - id: trailing-whitespace + - repo: https://github.com/crate-ci/typos + rev: v1.24.6 + hooks: + - id: typos + - repo: https://github.com/commitizen-tools/commitizen + rev: v3.29.0 + hooks: + - id: commitizen + - id: commitizen-branch + stages: [ push ] diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..f8863f8 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,20 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +### Added + +- support some features + +### Changed + +- change some existed behaviors/logic + +### Fixed + +- fix some bugs diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..d3da7b7 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,3 @@ +# Code of Conduct + +This project adheres to the Python Code of Conduct, which can be found [here](https://www.rust-lang.org/policies/code-of-conduct). diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..58c0542 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,50 @@ +# Contribution guidelines + +First off, thank you for considering contributing to `example-rs`. + +If your contribution is not straightforward, please first discuss the change you +wish to make by creating a new issue before making the change. + +## Reporting issues + +Before reporting an issue on the +[issue tracker](https://github.com/x-pt/example-rs/issues), +please check that it has not already been reported by searching for some related +keywords. + +## Pull requests + +Try to do one pull request per change. + +### Updating the changelog + +Update the changes you have made in +[CHANGELOG](CHANGELOG.md) +file under the **Unreleased** section. + +Add the changes of your pull request to one of the following subsections, +depending on the types of changes defined by +[Keep a changelog](https://keepachangelog.com/en/1.0.0/): + +- `Added` for new features. +- `Changed` for changes in existing functionality. +- `Deprecated` for soon-to-be removed features. +- `Removed` for now removed features. +- `Fixed` for any bug fixes. +- `Security` in case of vulnerabilities. + +If the required subsection does not exist yet under **Unreleased**, create it! + +## Developing + +### Set up + +This is no different from other Python projects. + +```shell +git clone https://github.com/x-pt/example-rs +cd example-rs +make test +``` + +### Useful Commands diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..0bc3834 --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,10 @@ +[package] +name = "example-rs" +version = "0.0.1" +edition = "2021" +description = "A nice example project" +repository = "https://github.com/x-pt/example-rs" +homepage = "https://github.com/x-pt/example-rs" +license = "MIT OR Apache-2.0" + +[dependencies] diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..cb42113 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,33 @@ +# Stage 1: Build the Rust project using the official Rust image +FROM rust:1-bookworm as builder + +# Install required dependencies for building +RUN apt-get update && apt-get install -y \ + pkg-config \ + libssl-dev \ + build-essential \ + && rm -rf /var/lib/apt/lists/* + +# Set the working directory inside the container +WORKDIR /app + +# Copy the project files into the container +COPY . . + +# Build the project in release mode +RUN cargo build --release + +# Stage 2: Create a minimal image using distroless for running the app +FROM gcr.io/distroless/cc-debian12 + +# Create app directory +WORKDIR /app + +# Copy the built executable from the builder stage +COPY --from=builder /app/target/release/example-rs /app/ + +# Expose the port (for example, 8080) +EXPOSE 8080 + +# Run the binary +CMD ["./example-rs"] diff --git a/LICENSE-APACHE b/LICENSE-APACHE new file mode 100644 index 0000000..1b5ec8b --- /dev/null +++ b/LICENSE-APACHE @@ -0,0 +1,176 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + +2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + +3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + +4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + +5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + +6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + +8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS diff --git a/LICENSE-MIT b/LICENSE-MIT new file mode 100644 index 0000000..38b41f0 --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2024 X Author Name + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..694d7ee --- /dev/null +++ b/Makefile @@ -0,0 +1,60 @@ +.PHONY: help build test fmt clippy doc image clean +.DEFAULT_GOAL := help + +APP_NAME := example-rs + +# Build the project +build: + @cargo build --release + +# Run tests +test: + @cargo test + +# Format code +fmt: + @cargo fmt + +# Run clippy +clippy: + @cargo clippy -- -D warnings + +# Generate documentation +doc: + @cargo doc --no-deps + +# Build image +image: + @docker image build -t $(APP_NAME) . + +# Start a compose service +compose-up: + @docker compose -f ./compose.yml -p $(APP_NAME) up -d + +# Shutdown a compose service +compose-down: + @docker compose -f ./compose.yml down + +# Clean build artifacts +clean: + @cargo clean + @rm -rf target + @docker compose -f ./compose.yml down -v + @docker image rm -f $(APP_NAME) + +# Show help +help: + @echo "" + @echo "Usage:" + @echo " make [target]" + @echo "" + @echo "Targets:" + @awk '/^[a-zA-Z\-_0-9]+:/ \ + { \ + helpMessage = match(lastLine, /^# (.*)/); \ + if (helpMessage) { \ + helpCommand = substr($$1, 0, index($$1, ":")-1); \ + helpMessage = substr(lastLine, RSTART + 2, RLENGTH); \ + printf "\033[36m%-22s\033[0m %s\n", helpCommand,helpMessage; \ + } \ + } { lastLine = $$0 }' $(MAKEFILE_LIST) diff --git a/README.md b/README.md new file mode 100644 index 0000000..3a7ab99 --- /dev/null +++ b/README.md @@ -0,0 +1,116 @@ +# Example Rs + +[![CI](https://github.com/x-pt/example-rs/workflows/CI/badge.svg)](https://github.com/x-pt/example-rs/actions) +[![Crates.io](https://img.shields.io/crates/v/Example Rs.svg)](https://crates.io/crates/Example Rs) +[![Documentation](https://docs.rs/Example Rs/badge.svg)](https://docs.rs/Example Rs) +[![License](https://img.shields.io/badge/license-MIT%2FApache--2.0-blue.svg)](README.md#license) + +## Table of Contents + +- [Overview](#overview) +- [Features](#features) +- [Quick Start](#quick-start) +- [Installation](#installation) + - [Requirements](#requirements) + - [User Installation](#user-installation) +- [Usage](#usage) +- [Development](#development) +- [Troubleshooting](#troubleshooting) +- [Contributing](#contributing) +- [License](#license) +- [Changelog](#changelog) +- [Contact](#contact) +- [Acknowledgements](#acknowledgements) + +## Overview + +`example-rs` is a Rust project designed to [brief description of the project's main purpose or functionality]. This project aims to [explain the primary goals or problems it solves]. + +## Features + +- **Feature 1**: [Detailed description of feature 1 and its benefits] +- **Feature 2**: [Detailed description of feature 2 and its benefits] +- **Feature 3**: [Detailed description of feature 3 and its benefits] +- [Add more features as needed] + +## Quick Start + +```rust +use example-rs; + +fn main() { + // Example usage + let result = example-rs::do_something(); + println!("{:?}", result); + + // Add more examples showcasing key features +} +``` + +## Installation + +### Requirements + +- Rust 1.81+ +- Dependencies: + - [Dependency 1]: [version] - [brief description or purpose] + - [Dependency 2]: [version] - [brief description or purpose] + - [Add more dependencies as needed] + +### User Installation + +Add `example-rs` to your `Cargo.toml`: + +```toml +[dependencies] +example-rs = "0.1.0" +``` + +## Usage + +Here's a brief overview of basic usage: + +```rust +use Example Rs; + +fn main() { + // Example usage + let result = Example Rs::do_something(); + println!("{:?}", result); +} +``` + +For more detailed examples and explanations of key concepts, please refer to our comprehensive [Usage Guide](docs/usage.md). + +## Development + +For information on setting up the development environment, running tests, and contributing to the project, please refer to our [Development Guide](docs/development.md). + +## Troubleshooting + +If you encounter any issues while using `example-rs`, please check our [Troubleshooting Guide](docs/troubleshooting.md) for common problems and their solutions. If you can't find a solution to your problem, please [open an issue](https://github.com/x-pt/example-rs/issues) on our GitHub repository. + +## Contributing + +We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details on how to submit pull requests, report issues, or suggest improvements. + +## License + +This project is licensed under either of: + +- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0) +- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) + +at your option. + +## Changelog + +For a detailed history of changes to this project, please refer to our [CHANGELOG.md](CHANGELOG.md). + +## Contact + +[Provide information on how to contact the maintainers or where to ask questions] + +## Acknowledgements + +[Acknowledge contributors, inspirations, or resources used in the project] diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..abdcf15 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,25 @@ +# Security Policy + +## Supported Versions + + + +| Version | Supported | +|---------|--------------------| +| 5.1.x | :white_check_mark: | +| 5.0.x | :x: | +| 4.0.x | :white_check_mark: | +| < 4.0 | :x: | + +## Reporting a Vulnerability + + diff --git a/cliff.toml b/cliff.toml new file mode 100644 index 0000000..db43be9 --- /dev/null +++ b/cliff.toml @@ -0,0 +1,131 @@ +# git-cliff ~ default configuration file +# https://git-cliff.org/docs/configuration +# +# Lines starting with "#" are comments. +# Configuration options are organized into tables and keys. +# See documentation for more information on available options. + +[remote.github] +owner = "x-pt" +repo = "example-rs" + +[changelog] +# template for the changelog footer +header = """ +# Changelog\n +All notable changes to this project will be documented in this file.\n +""" +# template for the changelog body +# https://keats.github.io/tera/docs/#introduction +body = """ +{%- macro remote_url() -%} + https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }} +{%- endmacro -%} + +{% macro print_commit(commit) -%} + - {% if commit.scope %}*({{ commit.scope }})* {% endif %}\ + {% if commit.breaking %}[**breaking**] {% endif %}\ + {{ commit.message | upper_first }} - \ + ([{{ commit.id | truncate(length=7, end="") }}]({{ self::remote_url() }}/commit/{{ commit.id }}))\ +{% endmacro -%} + +{% if version %}\ + {% if previous.version %}\ + ## [{{ version | trim_start_matches(pat="v") }}]\ + ({{ self::remote_url() }}/compare/{{ previous.version }}..{{ version }}) - {{ timestamp | date(format="%Y-%m-%d") }} + {% else %}\ + ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }} + {% endif %}\ +{% else %}\ + ## [unreleased] +{% endif %}\ + +{% for group, commits in commits | group_by(attribute="group") %} + ### {{ group | striptags | trim | upper_first }} + {% for commit in commits + | filter(attribute="scope") + | sort(attribute="scope") %} + {{ self::print_commit(commit=commit) }} + {%- endfor %} + {% for commit in commits %} + {%- if not commit.scope -%} + {{ self::print_commit(commit=commit) }} + {% endif -%} + {% endfor -%} +{% endfor -%} +{%- if github -%} +{% if github.contributors | filter(attribute="is_first_time", value=true) | length != 0 %} + ## New Contributors โค๏ธ +{% endif %}\ +{% for contributor in github.contributors | filter(attribute="is_first_time", value=true) %} + * @{{ contributor.username }} made their first contribution + {%- if contributor.pr_number %} in \ + [#{{ contributor.pr_number }}]({{ self::remote_url() }}/pull/{{ contributor.pr_number }}) \ + {%- endif %} +{%- endfor -%} +{%- endif %} + + +""" + +# template for the changelog footer +footer = """ + +""" +# remove the leading and trailing s +trim = true +# postprocessors +postprocessors = [ + { pattern = '', replace = "https://github.com/x-pt/example-rs" }, # replace repository URL +] + +[git] +# parse the commits based on https://www.conventionalcommits.org +conventional_commits = true +# filter out the commits that are not conventional +filter_unconventional = true +# process each line of a commit as an individual commit +split_commits = false +# regex for preprocessing the commit messages +commit_preprocessors = [ + # Replace issue numbers + { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](/issues/${2}))"}, + # Check spelling of the commit with https://github.com/crate-ci/typos + # If the spelling is incorrect, it will be automatically fixed. + #{ pattern = '.*', replace_command = 'typos --write-changes -' }, +] +# regex for parsing and grouping commits +commit_parsers = [ + { message = "^feat", group = "๐Ÿš€ Features" }, + { message = "^fix", group = "๐Ÿ› Bug Fixes" }, + { message = "^doc", group = "๐Ÿ“š Documentation" }, + { message = "^perf", group = "โšก Performance" }, + { message = "^refactor", group = "๐Ÿšœ Refactor" }, + { message = "^style", group = "๐ŸŽจ Styling" }, + { message = "^test", group = "๐Ÿงช Testing" }, + { message = "^chore\\(release\\): prepare for", skip = true }, + { message = "^chore\\(release-bot\\): prepare for", skip = true }, + { message = "^chore: bump version to", skip = true }, + { message = "^chore\\(deps.*\\)", skip = true }, + { message = "^chore\\(pr\\)", skip = true }, + { message = "^chore\\(pull\\)", skip = true }, + { message = "^chore|^ci", group = "โš™๏ธ Miscellaneous Tasks" }, + { body = ".*security", group = "๐Ÿ›ก๏ธ Security" }, + { message = "^revert", group = "โ—€๏ธ Revert" }, +] +# protect breaking changes from being skipped due to matching a skipping commit_parser +protect_breaking_commits = false +# filter out the commits that are not matched by commit parsers +filter_commits = false +# regex for matching git tags +# tag_pattern = "v[0-9].*" +# regex for skipping tags +# skip_tags = "" +# regex for ignoring tags +# ignore_tags = "" +# sort the tags topologically +topo_order = false +# sort the commits inside sections by oldest/newest order +sort_commits = "newest" +# limit the number of commits included in the changelog. +# limit_commits = 42 diff --git a/compose.yml b/compose.yml new file mode 100644 index 0000000..17321d9 --- /dev/null +++ b/compose.yml @@ -0,0 +1,13 @@ +services: + example-rs: + build: . + image: example-rs + ports: + - 8000:8000 + +networks: + example-rs-net: + name: example-rs-net + ipam: + config: + - subnet: 172.16.238.0/24 diff --git a/docs/development.md b/docs/development.md new file mode 100644 index 0000000..cae1e79 --- /dev/null +++ b/docs/development.md @@ -0,0 +1,89 @@ +# Development Guide for Example Rs + +Welcome to the development guide for `Example Rs`! +This document will walk you through setting up your development environment, running tests, building the project, and maintaining code quality. + +## Table of Contents + +- [Setting Up the Development Environment](#setting-up-the-development-environment) + - [Prerequisites](#prerequisites) + - [Installation Steps](#installation-steps) +- [Running Tests](#running-tests) +- [Building the Project](#building-the-project) +- [Code Style and Linting](#code-style-and-linting) +- [Generating Documentation](#generating-documentation) + +## Setting Up the Development Environment + +1. **Clone the Repository**: Start by cloning the project repository to your local machine and navigate to the project directory: + + ```bash + git clone https://github.com/x-pt/example-rs.git + cd Example Rs + ``` + +2. **Build the Project**: This command compiles the project and its dependencies: + + ```bash + make build + ``` + +## Running Tests + +Tests are crucial to ensure the stability of the project. To run all tests, use the following command: + +```bash +make test +``` + +This command will compile the code and run all tests, ensuring all components work as expected. + +[Consider adding specific details on the structure of tests, testing strategy, or how to add new tests.] + +## Building the Project + +To build the project in release mode, use: + +```bash +make build +``` + +This command will generate an optimized executable in the `target/release` directory. + +## Code Style and Linting + +Maintaining consistent code style is essential. We use `rustfmt` for formatting and `clippy` for linting. + +To format your code, run: + +```bash +make fmt +``` + +To run the linter: + +```bash +make clippy +``` + +These commands will automatically check and optionally fix any code style issues according to the project's style guide. + +## Generating Documentation + +To generate the project documentation, run: + +```bash +make doc +``` + +This will create the documentation for your project and its dependencies. + +## Cleaning Up + +To clean up build artifacts and other generated files, you can use: + +```bash +make clean +``` + +This will remove the `target` directory and clean up any Docker-related resources. diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/usage.md b/docs/usage.md new file mode 100644 index 0000000..e69de29 diff --git a/src/main.rs b/src/main.rs new file mode 100644 index 0000000..e7a11a9 --- /dev/null +++ b/src/main.rs @@ -0,0 +1,3 @@ +fn main() { + println!("Hello, world!"); +}