Skip to content
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.

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

Add Branch Selection for coffee_install() #242

Closed
wants to merge 4 commits into from
Closed
Changes from 1 commit
Commits
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
Prev Previous commit
docs: add docs for coffee install --branch
Signed-off-by: Tarek <tareknaser360@gmail.com>
tareknaser committed Feb 23, 2024
commit d77053b8a5954b4fe179bde87c733751fcddfd9b
8 changes: 8 additions & 0 deletions docs/docs-book/src/using-coffee.md
Original file line number Diff line number Diff line change
@@ -104,6 +104,14 @@ To install a plugin statically, you simply need to run.
coffee install <plugin_name>
```

#### Specifying a branch for installation

To install a plugin from a specific branch, you simply need to run.

```bash
coffee install <plugin_name> --branch <branch_name>
```

Comment on lines +107 to +114
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we should not document every single command possibility otherwise our documentation will be always uncompleted

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right. I can remove this section

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

but we should came up with a way to document optional parameters

### Removing a Plugin

> ✅ Implemented

Unchanged files with check annotations Beta

//! from a plugin manager point of view.
use std::fmt::{self, Display};
use log;

Check warning on line 5 in coffee_lib/src/plugin.rs

GitHub Actions / Build (nightly)

the item `log` is imported redundantly

Check warning on line 5 in coffee_lib/src/plugin.rs

GitHub Actions / Build (nightly)

the item `log` is imported redundantly
use serde::{Deserialize, Serialize};
use tokio::process::Command;
use std::any::Any;
use async_trait::async_trait;
use git2;

Check warning on line 4 in coffee_github/src/repository.rs

GitHub Actions / Build (nightly)

the item `git2` is imported redundantly

Check warning on line 4 in coffee_github/src/repository.rs

GitHub Actions / Build (nightly)

the item `git2` is imported redundantly
use log::debug;
use tokio::fs::File;
use tokio::io::AsyncReadExt;
//! Coffee mod implementation
use std::collections::HashMap;
use std::fmt::Debug;
use std::vec::Vec;

Check warning on line 4 in coffee_core/src/coffee.rs

GitHub Actions / Build (nightly)

the item `Vec` is imported redundantly

Check warning on line 4 in coffee_core/src/coffee.rs

GitHub Actions / Build (nightly)

the item `Vec` is imported redundantly
use tokio::fs;
use async_trait::async_trait;
use clightningrpc_common::client::Client;
use clightningrpc_common::json_utils;
use clightningrpc_conf::{CLNConf, SyncCLNConf};
use log;

Check warning on line 11 in coffee_core/src/coffee.rs

GitHub Actions / Build (nightly)

the item `log` is imported redundantly

Check warning on line 11 in coffee_core/src/coffee.rs

GitHub Actions / Build (nightly)

the item `log` is imported redundantly
use serde::de::DeserializeOwned;
use serde::{Deserialize, Serialize};
use serde_json::json;