axodotdev / axodotdev/cargo-dist

local and global artifacts job configs have inconsistent names

Open
#721 1 comment 1 reaction 0 assignees View on GitHub
bug documentation good first issue
Dominant language
Rust
Stars
2.1k
Forks
149
Avg merge
1d 11h
Merged PRs (30d)
32

Description

I didn't really notice at the time, but [the docs for custom build jobs](https://opensource.axo.dev/cargo-dist/book/reference/config.html#build-global-artifacts-jobs) say that "build-local-artifacts-jobs" and "build-global-artifacts-jobs" are the names of these configs, but in fact they're "local-artifacts-jobs" and "global-artifacts-jobs".

The actual builtin CI task is "build-local-artifacts" and "build-global-artifacts", so the docs have the more consistent name. However, I'm coming around to a belief that these should be renamed to just "build-local" and "build-global" because "artifacts" is redundant and crowds out precious space in various UIs. (and then the config would be "build-local-jobs" and "build-global-jobs")

tbc this is "we have 2 names and i hate them both, let's use this 3rd name" (we can add as many aliases as we want for the configs)

Contributor guide

Open the contributing guide

Research direction

Start with the custom build jobs documentation linked in the issue and compare its config names with the actual builtin CI task names. Decide whether the configs should retain aliases or adopt the proposed build-local-jobs and build-global-jobs names; the work is done when the naming decision is implemented consistently in the configuration and documentation.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, release
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.