Skip to content

Commit c37dc92

Browse files
authored
remove archived forc-explore plugin from CI and docs (#7257)
## Description This repo was [archived ](https://github.com/FuelLabs/forc-explorer )in July 2024 but was not removed from CI or the docs. I have update the plugins section of the documentation from forc explore to `forc-install` which is a [tool](https://github.com/DarthBenro008/forc-install) from a community member. ## Checklist - [x] I have linked to any relevant issues. - [ ] I have commented my code, particularly in hard-to-understand areas. - [x] I have updated the documentation where relevant (API docs, the reference, and the Sway book). - [x] If my change requires substantial documentation changes, I have [requested support from the DevRel team](https://github.com/FuelLabs/devrel-requests/issues/new/choose) - [ ] I have added tests that prove my fix is effective or that my feature works. - [ ] I have added (or requested a maintainer to add) the necessary `Breaking*` or `New Feature` labels where relevant. - [x] I have done my best to ensure that my PR adheres to [the Fuel Labs Code Review Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md). - [x] I have requested a review from the relevant team or maintainers.
1 parent 586a968 commit c37dc92

File tree

9 files changed

+12
-21
lines changed

9 files changed

+12
-21
lines changed

.github/workflows/ci.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,6 @@ jobs:
245245
for dir in ./forc-plugins/*/; do
246246
cargo install --locked --path "$dir"
247247
done
248-
cargo install --locked forc-explore
249248
- name: Install mdbook-forc-documenter
250249
run: cargo install --locked --path ./scripts/mdbook-forc-documenter
251250

.github/workflows/gh-pages.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,6 @@ jobs:
3434
cargo install --locked --debug --path ./forc-plugins/forc-migrate
3535
cargo install --locked --debug --path ./forc-plugins/forc-node
3636
cargo install --locked --debug --path ./forc-plugins/forc-publish
37-
cargo install --locked --debug forc-explore
3837
- name: Install mdbook-forc-documenter
3938
uses: actions-rs/cargo@v1
4039
with:

ci_checks.sh

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,6 @@ cargo install --locked --debug --path ./forc-plugins/forc-fmt &&
2929
cargo install --locked --debug --path ./forc-plugins/forc-lsp &&
3030
cargo install --locked --debug --path ./forc-plugins/forc-client &&
3131
cargo install --locked --debug --path ./forc-plugins/forc-tx &&
32-
cargo install --locked --debug forc-explore &&
3332
cargo install --locked --debug --path ./scripts/mdbook-forc-documenter &&
3433
forc build --path sway-lib-std &&
3534
forc test --path sway-lib-std &&

docs/book/README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@ You must also install forc plugins that are already documented within the book.
2323
```sh
2424
cargo install --path ./forc-plugins/forc-client
2525
cargo install --path ./forc-plugins/forc-doc
26-
cargo install forc-explore
2726
cargo install --path ./forc-plugins/forc-fmt
2827
cargo install --path ./forc-plugins/forc-lsp
2928
```

docs/book/src/SUMMARY.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,6 @@
107107
- [forc crypto](./forc/plugins/forc_crypto.md)
108108
- [forc debug](./forc/plugins/forc_debug.md)
109109
- [forc doc](./forc/plugins/forc_doc.md)
110-
- [forc explore](./forc/plugins/forc_explore.md)
111110
- [forc fmt](./forc/plugins/forc_fmt.md)
112111
- [forc lsp](./forc/plugins/forc_lsp.md)
113112
- [forc migrate](./forc/plugins/forc_migrate.md)

docs/book/src/forc/plugins/forc_explore.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/book/src/forc/plugins/index.md

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,29 @@
11
# Plugins
22

3-
Plugins can be used to extend `forc` with new commands that go beyond the native commands mentioned in the previous chapter. While the Fuel ecosystem provides a few commonly useful plugins (`forc-fmt`, `forc-client`, `forc-lsp`, `forc-explore`), anyone can write their own!
3+
Plugins can be used to extend `forc` with new commands that go beyond the native commands mentioned in the previous chapter. While the Fuel ecosystem provides a few commonly useful plugins (`forc-fmt`, `forc-client`, `forc-lsp`, `forc-migrate`), anyone can write their own!
44

5-
Let's install a plugin, `forc-explore`, and see what's underneath the plugin:
5+
Let's install a plugin, `forc-install`, and see what's underneath the plugin:
66

77
```sh
8-
cargo install forc-explore
8+
git clone https://github.com/darthbenro008/forc-install
9+
cd forc-install
10+
cargo install --path .
911
```
1012

11-
Check that we have installed `forc-explore`:
13+
Check that we have installed `forc-install`:
1214

1315
```console
1416
$ forc plugins
1517
Installed Plugins:
16-
forc-explore
18+
forc-install
1719
```
1820

19-
`forc-explore` runs the Fuel Network Explorer, which you can run and check out for yourself:
21+
`forc-install` is a tool to manage GitHub dependencies in your Forc.toml file: For example, to install a sway library hosted on github:
2022

2123
```console
22-
$ forc explore
23-
Fuel Network Explorer 0.1.1
24-
Running server on http://127.0.0.1:3030
25-
Server::run{addr=127.0.0.1:3030}: listening on http://127.0.0.1:3030
24+
forc install https://github.com/user/sway-library
2625
```
2726

28-
You can visit <http://127.0.0.1:3030> to check out the network explorer!
29-
3027
Note that some plugin crates can also provide more than one command. For example, installing the `forc-client` plugin provides the `forc deploy` and `forc run` commands. This is achieved by specifying multiple `[[bin]]` targets within the `forc-client` manifest.
3128

3229
## Writing your own plugin

scripts/mdbook-forc-documenter/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ MDBOOK_preprocessor__FORC_documenter__STRICT="true" mdbook build docs/book
2121
Enter a new entry under the `Commands` section within `SUMMARY.md`, in this format:
2222

2323
```md
24-
- [forc explore](./forc_explore.md)
24+
- [forc fmt](./forc_fmt.md)
2525
```
2626

2727
### Adding a new forc plugin

scripts/mdbook-forc-documenter/src/commands.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,8 +104,8 @@ mod tests {
104104
#[test]
105105
fn test_get_forc_command_from_file_name() {
106106
assert_eq!(
107-
"forc explore",
108-
get_forc_command_from_file_name(OsString::from("forc_explore.md")),
107+
"forc fmt",
108+
get_forc_command_from_file_name(OsString::from("forc_fmt.md")),
109109
);
110110
}
111111
}

0 commit comments

Comments
 (0)