Skip to content

Add, remove, and set flags for project teams, labels, and initiatives #282

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
schpetbot wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add, remove, and set flags for project teams, labels, and initiatives #282

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
- `issue query --state` and `issue mine --state` accept a workflow state name or ID as well as the six state types, looked up within the queried team scope (all teams under `--all-teams`, where a name matches every team's same-named state). An unknown name errors and lists the scope's states, and types and names can be mixed
- `project update --content <markdown>` and `--content-file <path>` replace a project's long-form overview body, matching the flags `project create` already had. Previously the only way to change the body after creation was a hand-written `projectUpdate` mutation through `linear api`
- `issue update --clear-due-date`, `--clear-estimate`, `--clear-parent`, `--clear-project`, and `--clear-milestone`, plus `project update --clear-lead`, `--clear-start-date`, and `--clear-target-date`, to remove a value the way `--unassign` and `--clear-cycle` already do. Each sends an explicit `null` to Linear and errors when combined with its set flag; `--clear-project` also rejects `--milestone`, since a milestone belongs to the project being removed. Previously these fields could only be changed, never cleared: cliffy treats `--due-date ""` as a missing value
- `project update` now changes teams, labels, and initiatives with the same three operations `issue update` has for labels: `--team`, `--label`, and `--initiative` replace the whole set, `--add-team`/`--add-label`/`--add-initiative` append, and `--remove-team`/`--remove-label`/`--remove-initiative` detach, all repeatable, with a replace flag rejected alongside its add/remove flags. Linear's project input only accepts a full `teamIds`/`labelIds` list, so add and remove read the project's current set (every page of it) and send the computed set; initiatives have no input field at all and go through the initiative-to-project link mutations, so `project update` previously could not change them after `project create --initiative`. Removing a team, label, or initiative the project does not have errors and lists what it does have, and a link change that fails part-way reports what was applied and what is still pending
- `--json` (`-j`) on `team list`, `cycle list`, `cycle view`, `milestone list`, `milestone view`, and `project view`, the last read commands without machine-readable output. List commands emit the same `{ nodes, pageInfo }` connection shape as the other list commands, after the same filtering and ordering as the table; view commands emit the GraphQL object as fetched, including every issue rather than the ten-item preview, and `milestone view --all --json` includes every page. (A 2.0.0 entry claimed `cycle list --json`; that change never actually landed.) ([#276](https://github.com/schpet/linear-cli/issues/276); thanks @lakardion)

### Fixed
Expand Down
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,8 @@ linear project create --name "API v2" --team ENG --content-file overview.md
linear project create --name "Mobile launch" --team APP --priority high --label Launch --member jane@example.com
linear project update <projectId> --content-file overview.md # replace the project's overview body
linear project update <projectId> --clear-lead --clear-target-date # remove values (also --clear-start-date)
linear project update <projectId> --add-team OPS --remove-label Launch --add-initiative "Q4 Bets" # change teams, labels, initiatives incrementally
linear project update <projectId> --team ENG --team OPS # replace the whole team set (--label and --initiative replace likewise)
linear project comment list <project> # list the project's discussion thread (UUID, slug, or name)
linear project comment add <project> --body "Kickoff Monday" # comment on a project
linear project comment add <project> --body "+1" --reply-to <commentId> # reply in a thread
Expand Down
9 changes: 9 additions & 0 deletions docs/usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -317,6 +317,15 @@ linear project update PROJECT-ID --content-file overview.md

# Remove the lead, start date, or target date (each conflicts with its set flag)
linear project update PROJECT-ID --clear-lead --clear-start-date --clear-target-date

# Teams, labels, and initiatives are sets. --team, --label, and --initiative
# replace the whole set; --add-*/--remove-* change it incrementally. All are
# repeatable, and a replace flag cannot be combined with its add/remove flags.
linear project update PROJECT-ID --add-team OPS --remove-team APP
linear project update PROJECT-ID --add-label Launch --remove-label Beta
linear project update PROJECT-ID --add-initiative "Q4 Bets" # ID, slug, or name
linear project update PROJECT-ID --initiative "Q4 Bets" --initiative "Platform" # exactly these
# Removing a team, label, or initiative the project does not have is an error.
```

#### list projects
Expand Down
9 changes: 9 additions & 0 deletions skills/linear-cli/references/organization-features.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,15 @@ linear project view <id>
linear project create --name "New Feature" --team DEV
linear project create --name "Q1 Work" --team DEV --initiative "Q1 Goals"
linear project create -i # Interactive mode

# Change a project's teams, labels, or initiatives incrementally
linear project update <id> --add-team OPS --remove-team APP
linear project update <id> --add-label "Launch" --remove-label "Beta"
linear project update <id> --add-initiative "Q1 Goals" # ID, slug, or name

# Replace a whole set (cannot be combined with that set's --add-*/--remove-*)
linear project update <id> --team DEV --team OPS
linear project update <id> --initiative "Q1 Goals" --initiative "Platform"
```

## Bulk Operations
Expand Down
48 changes: 31 additions & 17 deletions skills/linear-cli/references/project.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,23 +191,37 @@ Description:

Options:

-h, --help - Show this help.
--workspace <slug> - Target workspace (uses credentials)
-n, --name <name> - Project name
-d, --description <description> - Project description (max 255 characters, enforced by Linear's API)
-f, --description-file <path> - Read project description from file (still subject to the 255-character API
limit)
--content <markdown> - Project overview markdown
--content-file <path> - Read project overview markdown from a file
-s, --status <status> - Status (planned, started, paused, completed, canceled, backlog)
-l, --lead <lead> - Project lead (username, email, or @me). Use --clear-lead to remove it
--clear-lead - Remove the project's lead (cannot be combined with --lead)
--start-date <startDate> - Start date (YYYY-MM-DD). Use --clear-start-date to remove it
--clear-start-date - Remove the project's start date (cannot be combined with --start-date)
--target-date <targetDate> - Target date (YYYY-MM-DD). Use --clear-target-date to remove it
--clear-target-date - Remove the project's target date (cannot be combined with --target-date)
-t, --team <team> - Team key, name, or ID (can be repeated for multiple teams)
--label <label> - Replace the project's labels. May be repeated to set multiple labels.
-h, --help - Show this help.
--workspace <slug> - Target workspace (uses credentials)
-n, --name <name> - Project name
-d, --description <description> - Project description (max 255 characters, enforced by Linear's API)
-f, --description-file <path> - Read project description from file (still subject to the 255-character API
limit)
--content <markdown> - Project overview markdown
--content-file <path> - Read project overview markdown from a file
-s, --status <status> - Status (planned, started, paused, completed, canceled, backlog)
-l, --lead <lead> - Project lead (username, email, or @me). Use --clear-lead to remove it
--clear-lead - Remove the project's lead (cannot be combined with --lead)
--start-date <startDate> - Start date (YYYY-MM-DD). Use --clear-start-date to remove it
--clear-start-date - Remove the project's start date (cannot be combined with --start-date)
--target-date <targetDate> - Target date (YYYY-MM-DD). Use --clear-target-date to remove it
--clear-target-date - Remove the project's target date (cannot be combined with --target-date)
-t, --team <team> - Team key, name, or ID; replaces the project's entire team set. May be repeated.
Use --add-team/--remove-team to change teams incrementally.
--add-team <team> - Add a team to the project, keeping its existing teams. May be repeated.
--remove-team <team> - Remove a team from the project, keeping its other teams. May be repeated.
--label <label> - Project label; replaces the project's entire label set. May be repeated. Use
--add-label/--remove-label to change labels incrementally.
--add-label <label> - Add a label to the project, keeping its existing labels. May be repeated.
--remove-label <label> - Remove a label from the project, keeping its other labels (does not delete the
label). May be repeated.
--initiative <initiative> - Initiative ID, slug, or name; replaces the project's entire initiative set. May
be repeated. Use --add-initiative/--remove-initiative to change initiatives
incrementally.
--add-initiative <initiative> - Add the project to an initiative, keeping its existing initiatives. May be
repeated.
--remove-initiative <initiative> - Remove the project from an initiative, keeping its other initiatives (does not
delete the initiative). May be repeated.
```

### view
Expand Down
Loading
Loading