Skip to content
This repository has been archived by the owner on Oct 25, 2024. It is now read-only.

chore: improve UX of forc index plugin commands #1142

Merged
merged 12 commits into from
Aug 1, 2023
Merged

chore: improve UX of forc index plugin commands #1142

merged 12 commits into from
Aug 1, 2023

Conversation

deekerno
Copy link
Contributor

@deekerno deekerno commented Jul 24, 2023 •
edited
Loading

Closes #1135.

Description

  • Removes redundant options from various forc index commands
  • Fixes a panic in forc index postgres create --help
  • Removes forc index init command
  • Updates CI
  • Updates documentation
  • Updates welcome message in forc index new

Testing steps

  1. Create an indexer with forc index new and ensure that all given values are respected:
    -- forc index new [path]
    -- forc index new [path] --name [name] --namespace [namespace] --native
  2. Run forc index check to ensure that components are still detected.

@deekerno deekerno self-assigned this Jul 24, 2023
@deekerno deekerno force-pushed the deekerno/1135-polish-plugin branch from 1188c63 to e89da3a Compare July 31, 2023 21:48
@deekerno deekerno marked this pull request as ready for review July 31, 2023 22:39
@deekerno deekerno requested a review from ra0x3 as a code owner July 31, 2023 22:39
@deekerno deekerno requested a review from lostman July 31, 2023 22:39
ra0x3
ra0x3 reviewed Aug 1, 2023
View reviewed changes
Copy link
Contributor

@ra0x3 ra0x3 left a comment

Choose a reason for hiding this comment

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

@deekerno

  • Cleanup looks fine.
  • Left some small pieces of feedback.
  • Also remember to update the --help output in the README with the new forc index --help.
  • Finally, remember to update the --help commands of each individual command in the docs (if we have those)

plugins/forc-index/src/cli.rs Outdated Show resolved Hide resolved
plugins/forc-postgres/src/commands/create.rs Show resolved Hide resolved
plugins/forc-index/src/ops/mod.rs Outdated Show resolved Hide resolved
plugins/forc-index/src/commands/mod.rs Outdated Show resolved Hide resolved
@deekerno deekerno force-pushed the deekerno/1135-polish-plugin branch from 7387dc1 to 1d584df Compare August 1, 2023 17:21
@deekerno deekerno force-pushed the deekerno/1135-polish-plugin branch from 1d584df to bed24ab Compare August 1, 2023 17:22
@deekerno deekerno force-pushed the deekerno/1135-polish-plugin branch from bed24ab to beb2a6b Compare August 1, 2023 17:26
@deekerno deekerno requested a review from ra0x3 August 1, 2023 17:27
@deekerno deekerno merged commit 3b58125 into develop Aug 1, 2023
45 checks passed
@deekerno deekerno deleted the deekerno/1135-polish-plugin branch August 1, 2023 18:34
ra0x3 added a commit that referenced this pull request Aug 2, 2023
@ra0x3 @deekerno
@AlicanC @rfuelsh @lostman @sarahschwartz
master <> develop (#1177)
354b330 
* fix: add sql endpoint auth + make `run_query` fail gracefully (#1136)

* fix: add sql endpoint auth

* retrigger ci?

---------

Co-authored-by: Rashad Alston <[email protected]>

* chore: switch to manual sqlx query logging (#1138)

* chore: switch to manual sqlx query logging

* fix test

* uat

* add rustdoc

---------

Co-authored-by: Rashad Alston <[email protected]>

* fix: update readme (#1141)

* enhancement: make `NODE_BLOCK_PAGE_SIZE` configurable (#1147)

* Replace blocking `reqwest` usage with async (#1148)

* Revert "Replace blocking `reqwest` usage with async" (#1151)

Revert "Replace blocking `reqwest` usage with async (#1148)"

This reverts commit 19dbf2a.

* docs: adjust docs to include `--block-page-size` on start commands (#1153)

Adjust docs for start commands

* Replace blocking `reqwest` usage with async (#1152)

* fix: don't skip blocks on constraint error (#1154)

* fix: don't skip blocks on constraint error

* fix test

---------

Co-authored-by: Rashad Alston <[email protected]>

* Adding resources to helm chart (#1160)

* Update --replace-indexer and add --remove-data (#1146)

* remove debug info message (#1163)

* docs: update non-book docs (#1161)

* docs: update non-book docs

* updates

* markdownrc

* update contributing.md

* update release schedule

* update example readmes

---------

Co-authored-by: Rashad Alston <[email protected]>

* Fix incorrect schema digest (#1165)

* forc index deploy: register correct schema

* bugfix: we are removing the schema and registering it again

* log registered asset version

* add docs CI (#1158)

* enhancement: implement many-to-many relationships (#1140)

* enhancement: impl m2m inserts

* update implementation

* get the explorer working

* update native exec

* cleanup + updates

* get union types working

* use multiple queries

* rebase origin/develop

* fix test

---------

Co-authored-by: Rashad Alston <[email protected]>

* chore: improve UX of `forc index` plugin commands (#1142)

* Remove forc index new

* Allow for optional namespace in forc index init

* Remove profile and target flags from forc index build; change release bool to debug

* Remove service check from forc index check

* Move service check into forc index status

* Cleanup

* Remove short arg collision from forc index postgres

* Fix CI

* Replace forc_index_init with forc_index_new

* Adjust tests and documentation

* Address feedback; clean up some other things

* Address everything for real this time

* ci: streamline develop <> master merges (#1166)

* ci: use new formatter + fix master<>develop merging  (#1169)

fix: new ci formatting + fix master<>develop merge

Co-authored-by: Rashad Alston <[email protected]>

* v0.19.0 (#1172)

Co-authored-by: Rashad Alston <[email protected]>

---------

Co-authored-by: Rashad Alston <[email protected]>
Co-authored-by: Alexander <[email protected]>
Co-authored-by: JC <[email protected]>
Co-authored-by: roy_fuel <[email protected]>
Co-authored-by: Maciej Woś <[email protected]>
Co-authored-by: Sarah Schwartz <[email protected]>
@ra0x3 ra0x3 mentioned this pull request Aug 2, 2023
Merged
7 tasks
ra0x3 added a commit that referenced this pull request Aug 2, 2023
@ra0x3 @deekerno
@AlicanC @rfuelsh @lostman @sarahschwartz
develop <> master (#1177) (#1180)
d5b12c9 
master <> develop (#1177)

* fix: add sql endpoint auth + make `run_query` fail gracefully (#1136)

* fix: add sql endpoint auth

* retrigger ci?

---------



* chore: switch to manual sqlx query logging (#1138)

* chore: switch to manual sqlx query logging

* fix test

* uat

* add rustdoc

---------



* fix: update readme (#1141)

* enhancement: make `NODE_BLOCK_PAGE_SIZE` configurable (#1147)

* Replace blocking `reqwest` usage with async (#1148)

* Revert "Replace blocking `reqwest` usage with async" (#1151)

Revert "Replace blocking `reqwest` usage with async (#1148)"

This reverts commit 19dbf2a.

* docs: adjust docs to include `--block-page-size` on start commands (#1153)

Adjust docs for start commands

* Replace blocking `reqwest` usage with async (#1152)

* fix: don't skip blocks on constraint error (#1154)

* fix: don't skip blocks on constraint error

* fix test

---------



* Adding resources to helm chart (#1160)

* Update --replace-indexer and add --remove-data (#1146)

* remove debug info message (#1163)

* docs: update non-book docs (#1161)

* docs: update non-book docs

* updates

* markdownrc

* update contributing.md

* update release schedule

* update example readmes

---------



* Fix incorrect schema digest (#1165)

* forc index deploy: register correct schema

* bugfix: we are removing the schema and registering it again

* log registered asset version

* add docs CI (#1158)

* enhancement: implement many-to-many relationships (#1140)

* enhancement: impl m2m inserts

* update implementation

* get the explorer working

* update native exec

* cleanup + updates

* get union types working

* use multiple queries

* rebase origin/develop

* fix test

---------



* chore: improve UX of `forc index` plugin commands (#1142)

* Remove forc index new

* Allow for optional namespace in forc index init

* Remove profile and target flags from forc index build; change release bool to debug

* Remove service check from forc index check

* Move service check into forc index status

* Cleanup

* Remove short arg collision from forc index postgres

* Fix CI

* Replace forc_index_init with forc_index_new

* Adjust tests and documentation

* Address feedback; clean up some other things

* Address everything for real this time

* ci: streamline develop <> master merges (#1166)

* ci: use new formatter + fix master<>develop merging  (#1169)

fix: new ci formatting + fix master<>develop merge



* v0.19.0 (#1172)



---------

Co-authored-by: Rashad Alston <[email protected]>
Co-authored-by: Alexander <[email protected]>
Co-authored-by: JC <[email protected]>
Co-authored-by: roy_fuel <[email protected]>
Co-authored-by: Maciej Woś <[email protected]>
Co-authored-by: Sarah Schwartz <[email protected]>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@ra0x3 ra0x3 ra0x3 approved these changes

@lostman lostman Awaiting requested review from lostman

Assignees

@deekerno deekerno

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Polish/update all plugin command
2 participants
@deekerno @ra0x3