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

Design PGXN CLI UX and DevEx #67

Open
2 tasks
theory opened this issue Sep 5, 2024 · 0 comments
Open
2 tasks

Design PGXN CLI UX and DevEx #67

theory opened this issue Sep 5, 2024 · 0 comments
Labels
client Work on or for the benefit of a PGXN CLI design Designing the architecture, protocols, tools, and interfaces for PGXN v2 documentation Improvements or additions to documentation

Comments

@theory
Copy link
Member

theory commented Sep 5, 2024

Enumerate user and developer tasks and design CLI commands to simplify or eliminate those tasks. Modify the CLI sketch as appropriate and turn it into a proper design document. (Publish as an RFC? Or addd ARDs?) Where possible, maintain compatibility with pgxn v1 and trunk.

Incomplete list of potential user tasks to design for:

  • Standard Help, Version, and manual/info commands/options
  • List installed extensions
  • Install trunk binary package
  • Build, package and install source distribution
  • Unininstall a package
  • Download a source distribution
  • Download a trunk binary package
  • Load a CREATE EXTENSION extension into a database
  • Unload a CREATE EXTENSION extension from a database

Incomplete list of potential developer tasks to design for:

  • Create a new extension from templates
  • Increment a version in all relevant files
  • Add a dependency (PGXN, core, or third-party)
  • Build the extension in the current directory
  • Package and install the extension
  • Uninstall the extension
  • Run unit/functional tests
  • Run acceptance/install tests
  • Release source on PGXN
  • Edit metadata (PGXN, pgrx, etc.)

Done when:

  • A complete design has been published, ideally with stubbed documentation, and the community has provided feedback for 3-6 weeks
  • A development plan has been worked out and turned into issues in the 🛠️ CLI Milestone.
@theory theory added documentation Improvements or additions to documentation design Designing the architecture, protocols, tools, and interfaces for PGXN v2 client Work on or for the benefit of a PGXN CLI labels Sep 5, 2024
@theory theory added this to the 🛠️ DevEx milestone Sep 5, 2024
@theory theory added this to PGXN v2 Sep 5, 2024
@github-project-automation github-project-automation bot moved this to Backlog in PGXN v2 Sep 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
client Work on or for the benefit of a PGXN CLI design Designing the architecture, protocols, tools, and interfaces for PGXN v2 documentation Improvements or additions to documentation
Projects
Status: Ready
Development

No branches or pull requests

1 participant