Refactor: import-targets to import-artifacts
#421
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kairoaraujo
force-pushed
the
import-target_to_import-artifacts
branch
2 times, most recently
from
4a9a1c8 to
4cf72c5
Compare
- Updates the user commands to show as `import-artifacts` instead `import-targets` following the changes in the API and documentation. Signed-off-by: Kairo de Araujo <[email protected]>
kairoaraujo
force-pushed
the
import-target_to_import-artifacts
branch
from
4cf72c5 to
4d92647
Compare
Codecov ReportAll modified lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #421 +/- ##
=======================================
Coverage 98.64% 98.64%
=======================================
Files 16 16
Lines 1181 1181
=======================================
Hits 1165 1165
Misses 16 16
☔ View full report in Codecov by Sentry. |
MVrachev
reviewed
Oct 13, 2023
There was a problem hiding this comment.
A few recommendations where to rename targets to artifacts:
- https://github.com/kairoaraujo/repository-service-tuf-cli/blob/4d92647e388a496fda5cce45abc5cf707850b200/pyproject.toml#L49-L50
- https://github.com/kairoaraujo/repository-service-tuf-cli/blob/4d92647e388a496fda5cce45abc5cf707850b200/repository_service_tuf/cli/admin/ceremony.py#L216
- !!! BUG !!! https://github.com/kairoaraujo/repository-service-tuf-cli/blob/4d92647e388a496fda5cce45abc5cf707850b200/repository_service_tuf/helpers/api_client.py#L23 I am in favor of renaming the enum URL from
public_targetstopublic_artifactshere - If you rename
publish_targetsabove you can consider doing here: and here https://github.com/kairoaraujo/repository-service-tuf-cli/blob/4d92647e388a496fda5cce45abc5cf707850b200/repository_service_tuf/helpers/api_client.py#L161
| @@ -711,13 +712,14 @@ sign (``sign``) | |||
|
|
|||
|
|
|||
| .. rstuf-cli-admin-import-targets | |||
There was a problem hiding this comment.
Suggested change
| .. rstuf-cli-admin-import-targets |
There was a problem hiding this comment.
It is to not break the docs in the umbrella until we update the sphinx import links.
| ╰──────────────────────────────────────────────────────────────────────────────╯ | ||
| ╭─ Commands ───────────────────────────────────────────────────────────────────╮ | ||
| │ ceremony Start a new Metadata Ceremony. │ | ||
| │ import-artifacts Import artifacts to RSTUF from exported CSV file.│ |
There was a problem hiding this comment.
Suggested change
| │ import-artifacts Import artifacts to RSTUF from exported CSV file.│ | |
| │ import-artifacts Import artifacts to RSTUF from exported CSV file. │ |
There was a problem hiding this comment.
If you do that you need to add a space to the other rows as well.
There was a problem hiding this comment.
I think we can keep it. It is just an example to the user in the docs., unless there are other changes to do.
Signed-off-by: Kairo de Araujo <[email protected]>
Done Done
I'm not renaming now. We can do it as another issue. This PR was intended to change the user views. |
Closed
1 task
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
import-artifactsinsteadimport-targetsfollowing the changes in the API and documentation.Types of changes
Additional requirements
Code of Conduct
By submitting this PR, you agree to follow our Code of Conduct.