jeertmans/rpdf

[FEATURE] Publish build artifacts and refer to `cargo binstall`

Open

#79 opened on Sep 27, 2024

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Rust (1 fork)auto 404
enhancementgood first issuehacktoberfest

Repository metrics

Stars
 (44 stars)
PR merge metrics
 (PR metrics pending)

Description

Issue

Currently, the only way to install rpdf is via cargo install.

While this is fine, one needs to compile the binaries locally, which is time-consuming.

Solution

We should provide, when publishing a new GitHub release, build artifacts with binaries for most common platform, through GitHub workflows.

One example of such workflow is the following: https://github.com/jeertmans/languagetool-rust/blob/v2.1.4/.github/workflows/release.yml

Please feel free to submit a PR with your implementation if you want to help!

Contributor guide

Research direction
Study the example release workflow at https://github.com/jeertmans/languagetool rust/blob/v2.1.4/.github/workflows/release.yml and adapt it to build and upload binaries for rpdf. Then configure cargo binstall by adding a tag and ensuring the release artifacts follow the expected naming conventions.
Tech stack
rust
Domain
clibuild systemdevopsrelease
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
RustGitHub Actions
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75