Skip to content

Commit

Permalink
Merge remote-tracking branch 'upstream/main' into json-logs
Browse files Browse the repository at this point in the history
# Conflicts:
#	Cargo.toml
  • Loading branch information
tazz4843 committed Aug 14, 2023
2 parents db1f549 + 7fbac54 commit 9b92167
Show file tree
Hide file tree
Showing 14 changed files with 160 additions and 15 deletions.
1 change: 1 addition & 0 deletions .envrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
git team disable
36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/security.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: Security issue
description: File a security issue in the crate
title: "[Security]: "
labels: ["bug", "security", "triage"]
assignees:
- flying7eleven
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this security report! Please refer to the security guidelines before submitting a issue regarding security!
- type: input
id: contact-gpg-key
attributes:
label: Contact GPG key
description: What is the id of your public GPG key to communicate with you?
placeholder: ex. 0xDEADBEEF
validations:
required: true
- type: textarea
id: bug-description
attributes:
label: What happened?
description: Please tell us what happend. Paste here the **encrypted** version of the description.
placeholder: Tell us what you see!
value: "There is a security issue!"
validations:
required: true
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/flying7eleven/fenrir-rs/blob/main/CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true
6 changes: 4 additions & 2 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ jobs:
- nightly
steps:
- uses: actions/checkout@v3
- run: rustup update ${{ matrix.toolchain }} && rustup default ${{ matrix.toolchain }}
- run: |
rustup override set ${{ matrix.toolchain }}
rustup update ${{ matrix.toolchain }}
- run: cargo build --all-features --verbose
- run: cargo test --all-features --verbose
- run: cargo test --all-features --verbose
19 changes: 19 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: Build the docs for the library
on:
push:
branches: [ "main" ]
pull_request:
branches: [ "main" ]
env:
CARGO_TERM_COLOR: always
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- run: |
rustup override set nightly
rustup update nightly
- run: cargo +nightly --version
- run: cargo +nightly clean
- run: cargo +nightly rustdoc --lib -Zrustdoc-map --all-features -Zunstable-options
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
.DS_Store
/.idea
**/target
/Cargo.lock
8 changes: 8 additions & 0 deletions .idea/.gitignore

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

12 changes: 12 additions & 0 deletions .idea/fenrir-rs.iml

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

8 changes: 8 additions & 0 deletions .idea/modules.xml

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

6 changes: 6 additions & 0 deletions .idea/vcs.xml

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

9 changes: 7 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,15 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
## Unreleased

### Added
__TODO__
___TODO___

## 0.5.1 - 2023-07-11

### Fixed
- Building the docs for this library should now work with `nightly` Rust versions (used by [docs.rs](https://docs.rs))

### Changed
__TODO__
- Upgrade all used dependencies to their latest versions

## 0.5.0 - 2023-07-06

Expand Down
27 changes: 27 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# How to contribute to fenrir-rs

## **Did you find a bug?**

* **Do not open up a GitHub issue if the bug is a security vulnerability in fenrir-rs**, and instead to refer to the [security policy](https://github.com/flying7eleven/fenrir-rs/blob/main/SECURITY.md).

* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/flying7eleven/fenrir-rs/issues).

* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/flying7eleven/fenrir-rs/issues/new/choose).
Be sure to select the **correct template** as well as include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.

## **Did you write a patch that fixes a bug?**

* Open a new GitHub pull request with the patch.

* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

* Before submitting, please read the [style guide](https://github.com/flying7eleven/fenrir-rs/blob/main/STYLEGUIDE.md) to know more about coding conventions.

## **Do you intend to add a new feature or change an existing one?**

* **Ensure the suggested change was not already proposed** by searching on GitHub under [Issues](https://github.com/flying7eleven/fenrir-rs/issues).

* If you're unable to find an open issue addressing the suggested change, [open a new one](https://github.com/flying7eleven/fenrir-rs/issues/new/choose).
Be sure to select the **correct template** as well as include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the proposed feature.

Thanks! :heart: :heart: :heart:
5 changes: 3 additions & 2 deletions CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Contributors

## Special thanks for all the people who had helped this project so far:
Special thanks for all the people who had helped this project so far:

* [Zero](https://github.com/tazz4843)
* [flying7eleven](https://github.com/flying7eleven): The maintainer and main developer for the project
* [Zero](https://github.com/tazz4843): Added support for `reqwest` as a backend for network access
20 changes: 12 additions & 8 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "fenrir-rs"
version = "0.5.0"
version = "0.5.1"
edition = "2021"
authors = ["Tim Janke <[email protected]>"]
repository = "https://github.com/flying7eleven/fenrir-rs"
Expand All @@ -12,25 +12,25 @@ license = "MIT"
rust-version = "1.60.0"

[dependencies.log]
version = "0.4.17"
version = "0.4.18"
default-features = false

[dependencies.url]
version = "2.3.1"
default-features = false

[dependencies.serde]
version = "1.0.162"
version = "1.0.163"
default-features = false
features = ["std", "derive"]

[dependencies.base64]
version = "0.21.0"
version = "0.21.2"
default-features = false
features = ["std"]

[dependencies.parking_lot]
version = "0.12"
version = "0.12.1"

[dependencies.serde_json]
version = "1.0.96"
Expand All @@ -44,15 +44,19 @@ default-features = false
optional = true

[dependencies.reqwest]
version = "0.11"
version = "0.11.18"
default-features = false
optional = true

[dependencies.tokio]
version = "1"
version = "1.28.2"
default-features = false
optional = true

[dev-dependencies.value-bag]
version = "1.4.1"
default-features = false

[dependencies.cfg-if]
version = "1"
default-features = false
Expand All @@ -66,7 +70,7 @@ version = "2.1.0"
default-features = false

[dev-dependencies.tokio]
version = "1"
version = "1.28.2"
features = ["rt-multi-thread", "macros"]

[features]
Expand Down
17 changes: 17 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Security Policy

## Supported Versions

The library has no stable release so far and only the last developed version is currently supported.
This will change as soon as the first stable version is released.

| Version | Supported |
|-----------|--------------------|
| >= latest | :white_check_mark: |
| < latest | :x: |

With *latest* the [last released version](https://github.com/flying7eleven/fenrir-rs/releases) is meant.

## Reporting a Vulnerability

Use the GPG public key `0x1FCA9D0B39C6F113` for encrypting your report and [open a new issue](https://github.com/flying7eleven/fenrir-rs/issues/new/choose) for pasting your **encrypted** description.

0 comments on commit 9b92167

Please sign in to comment.