docs: `--use-docker` and `--no-docker` options of `cfn submit` are missing from the documentation
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 2/5
- Temps estimé
- 1-3 heures
- Accessibilité débutants
- 92/100
- Type d'issue
- Documentation
- Clarté
- Clairement spécifiée
- Activité
- Calme
- Stack technique
- python
- Domaine
- cli, documentation
Piste de recherche
Ouvrez doc_source/resource-type-cli-submit.md et comparez son synopsis et ses options avec les définitions de src/rpdk/core/submit.py. Documentez --use-docker et --no-docker, y compris leur exclusion mutuelle et leur comportement de remplacement pour .rpdk-config. Le travail est terminé lorsque les deux flags apparaissent dans le synopsis et disposent d’entrées d’option complètes.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
Summary
The --use-docker and --no-docker options were added to cfn submit in #970 (merged on May 4, 2023), but the documentation was not updated in the same change. As a result:
doc_source/resource-type-cli-submit.mdin this repository does not mention either option.- The public AWS documentation page (which is generated from
doc_source/) also does not mention them.
Users can discover these options only by running cfn submit --help or by reading the source code.
Current state
In src/rpdk/core/submit.py, the options are registered like this:
nodocker_group = parser.add_mutually_exclusive_group()
nodocker_group.add_argument(
"--use-docker",
action="store_true",
help="""Use docker for platform-independent packaging.
This is highly recommended unless you are experienced
with cross-platform packaging.""",
)
nodocker_group.add_argument(
"--no-docker",
action="store_true",
help="""Generally not recommended unless you are experienced
with cross-platform packaging.""",
)
But doc_source/resource-type-cli-submit.md lists only:
[--dry-run]
[--endpoint-url <value>]
[--profile <value>]
[--region <value>]
[--role-arn <value>]
[--no-role]
[--set-default]
Proposed fix
Update doc_source/resource-type-cli-submit.md to:
- Add
[--use-docker]and[--no-docker]to the Synopsis block. - Add an entry for each option under the Options section, describing:
- What the option does.
- That
--use-dockerand--no-dockerare mutually exclusive. - That these flags override the
use_docker/no_dockersetting in.rpdk-config.
Additional context
I'd like to pick this up and send a PR if that's okay.
- Langage dominant
- Python
- Étoiles
- 336
- Forks
- 173
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Préparer son environnement
- Aucun Dockerfile ni fichier Docker Compose
- Propose un modèle de pull request
- Lire le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de aws-cloudformation/cloudformation-cli
-
Difficulté 2/5 1-3 heures Accessibilité débutants 62/100
-
Difficulté 3/5 1-2 jours Accessibilité débutants 55/100
aws-cloudformation/cloudformation-cli#1117 · 1 commentaire · 6 réactions ·
-
Difficulté 4/5 3-5 jours Accessibilité débutants 25/100
-
Difficulté 4/5 3-5 jours Accessibilité débutants 35/100
aws-cloudformation/cloudformation-cli#1115 · 1 commentaire · 9 réactions ·
-
Difficulté 4/5 3-5 jours Accessibilité débutants 38/100
Toutes les issues de aws-cloudformation/cloudformation-cli
Issues similaires
-
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
samuelcolvin/dirty-equals#148 ·
-
nomination-2026
Difficulté 1/5 Moins d'une heure Accessibilité débutants 70/100
elisa-tech/tsc#101 ·
-
Difficulté 2/5 1-3 heures Accessibilité débutants 63/100
-
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
JulianKemmerer/PipelineC#395 ·
-
The flake8 settings select checks that are not installed, and the test workflow passes inputs that setup-micromamba does not havePeut-être pris @HTenkanen l’a pris aujourd’hui. Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 74/100
Les mainteneurs répondent en général sous 1 jour