rust-windowing / rust-windowing/winit

Discussion: Start committing our lockfile

Open
#3,085 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

C - needs discussion S - meta
Dominant language
Rust
Stars
6.2k
Forks
1.3k
Avg merge
2d 19h
Merged PRs (30d)
9

Description

In a recent blog post, the Cargo Team outlined some reasons why they've changed the default for cargo new to not exclude the lockfile from version control.

I think winit should follow that direction, and start committing our Cargo.lock.

This would help greatly with our CI setup, both simplifying it in terms of caching, as well as making it break much less often due to changes in our dependencies.

On the other hand, perhaps it's a good thing that our CI breaks on changes in dependencies, it helps them discover unintended changes - hence why this is a discussion.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the linked Cargo Team blog post and inspecting how winit currently handles Cargo.lock in version control and CI. Compare the caching and dependency-change tradeoffs described in the discussion; done means reaching and documenting a project decision about committing the lockfile.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
build-system, ci-cd
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.