8000 Add command for removing libraries or releases by per1234 · Pull Request #73 · arduino/libraries-repository-engine · GitHub
[go: up one dir, main page]

Skip to content

Add command for removing libraries or releases #73

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

Merged
merged 6 commits into from
Aug 25, 2021
Merged

Add command for removing libraries or releases #73

merged 6 commits into from
Aug 25, 2021

Conversation

per1234
Copy link
Contributor
@per1234 per1234 commented Aug 25, 2021

Once a library submission is accepted, the registration and releases is stored in the library database. This means that
a library release or library will remain in Library Manager even after the removal of a tag or repository by the library
maintainer, or the removal of the library's registration from the registry.

A library release or library removal requires direct action by a maintainer. This procedure will be facilitated by adding
the capability to the engine tool's command line interface in the form of the new remove subcommand.

It can be used to remove specific releases:

libraries-repository-engine remove LIBRARY_NAME@VERSION...

or libraries entirely:

libraries-repository-engine remove LIBRARY_NAME...

These methods allow for removal of libraries and releases from the database.
This can be used for recovery in the event something goes wrong while in the middle of a operation that modified the
production files content.
Previously, the tool's command line interface was only ever intended to provide the "sync" functionality so a single
"all" integration test file was reasonable. Now that additional distinct command line functionality is planned, it will
be better to separate the integration tests into multiple files to make it easier for the developer to navigate the code.
This will make writing tests easier and avoid code duplication.
Once a library submission is accepted, the registration and releases is stored in the library database. This means that
a library release or library will remain in Library Manager even after the removal of a tag or repository by the library
maintainer, or the removal of the library's registration from the registry.

A library release or library removal requires direct action by a maintainer. This procedure will be facilitated by adding
the capability to the engine tool's command line interface in the form of the new `remove` subcommand.

It can be used to remove specific releases:

```
libraries-repository-engine remove LIBRARY_NAME@VERSION...
```

or libraries entirely:

```
libraries-repository-engine remove LIBRARY_NAME...
```
Rather than maintaining duplicated command line interface description in the readme, it is better to direct the user to
run the `help` command, which will always provide the complete current documentation.
@per1234 per1234 added type: enhancement Proposed improvement topic: code Related to content of the project itself labels Aug 25, 2021
@per1234 per1234 merged commit 217e559 into arduino:main Aug 25, 2021
@per1234 per1234 deleted the remove-command branch August 25, 2021 11:23
@per1234 per1234 self-assigned this Nov 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: code Related to content of the project itself type: enhancement Proposed improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants
0