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

Fail loudly and immediately if we can't gen docs #569

Merged
merged 2 commits into from
Dec 20, 2013

Conversation

jamesls
Copy link
Member

@jamesls jamesls commented Dec 20, 2013

If htmlgen fails, the whole process fails immediately and you get
a non zero RC. Previously it would just move on to the rendering
step, which makes it harder to notice build errors.

You now get:

  ...rds
  ...redshift
  ...route53
  ...s3
  ...s3api
  Traceback (most recent call last):
    File "aws-cli/doc/source/htmlgen", line 108, in <module>
      do_provider(driver)
    File "aws-cli/doc/source/htmlgen", line 66, in do_provider
      do_service(driver, REF_PATH, service_name, service_command)
    File "aws-cli/doc/source/htmlgen", line 48, in do_service
      help_command(None, None)
    File "aws-cli/awscli/help.py", line 232, in __call__
      bcdoc.docevents.generate_events(self.session, self)
    File "bcdoc/docevents.py", line 50, in generate_events
      help_command.name, help_command=help_command)
    File "bcdoc/docevents.py", line 36, in fire_event
      session.emit(event, **kwargs)
    File "botocore/botocore/session.py", line 551, in emit
      return self._events.emit(event_name, **kwargs)
    File "botocore/botocore/hooks.py", line 158, in emit
      response = handler(**kwargs)
    File "aws-cli/awscli/clidocs.py", line 243, in doc_description
      doc.include_doc_string(service.documentation)
  AttributeError: 'Service' object has no attribute 'documentation'
  Failed to generate documetation!
  make: *** [html] Error 2

  $ echo $?
  2

If htmlgen fails, the whole process fails immediately and you get
a non zero RC.  Previously it would just move on to the rendering
step, which makes it harder to notice build errors.

You now get:

  ...rds
  ...redshift
  ...route53
  ...s3
  ...s3api
  Traceback (most recent call last):
    File "aws-cli/doc/source/htmlgen", line 108, in <module>
      do_provider(driver)
    File "aws-cli/doc/source/htmlgen", line 66, in do_provider
      do_service(driver, REF_PATH, service_name, service_command)
    File "aws-cli/doc/source/htmlgen", line 48, in do_service
      help_command(None, None)
    File "aws-cli/awscli/help.py", line 232, in __call__
      bcdoc.docevents.generate_events(self.session, self)
    File "bcdoc/docevents.py", line 50, in generate_events
      help_command.name, help_command=help_command)
    File "bcdoc/docevents.py", line 36, in fire_event
      session.emit(event, **kwargs)
    File "botocore/botocore/session.py", line 551, in emit
      return self._events.emit(event_name, **kwargs)
    File "botocore/botocore/hooks.py", line 158, in emit
      response = handler(**kwargs)
    File "aws-cli/awscli/clidocs.py", line 243, in doc_description
      doc.include_doc_string(service.documentation)
  AttributeError: 'Service' object has no attribute 'documentation'
  Failed to generate documetation!
  make: *** [html] Error 2

  $ echo $?
  2
subprocess.call("python "+script_path, shell=True, env=os.environ)
rc = subprocess.call("python "+ script_path, shell=True, env=os.environ)
if rc != 0:
sys.stderr.write("Failed to generate documetation!\n")
Copy link
Member Author

Choose a reason for hiding this comment

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

uhg typo, I'll fix.

@garnaat
Copy link
Contributor

garnaat commented Dec 20, 2013

LGTM

@jamesls jamesls merged commit a9c5d41 into aws:develop Dec 20, 2013
@jamesls jamesls deleted the doc-fail-loudly branch June 23, 2014 18:27
thoward-godaddy pushed a commit to thoward-godaddy/aws-cli that referenced this pull request Feb 12, 2022
thoward-godaddy pushed a commit to thoward-godaddy/aws-cli that referenced this pull request Feb 12, 2022
* fix: Functional tests must run on localhost to work in Windows (aws#552)

* fix: spacing typo in Log statement in start-lambda (aws#559)

* docs: Fix syntax highlighting in README.md (aws#561)

* docs: Change jest to mocha in Nodejs init README (aws#564)

* docs: Fix @mhart link in README (aws#562)

* docs(README): removed cloudtrail, added SNS to generate-event (aws#569)

* docs: Update repo name references (aws#577)

* feat(debugging): Fixing issues around debugging Golang functions. (aws#565)

* fix(init): Improve current init samples around docs and fixes (aws#558)

* docs(README): Update launch config to SAM CLI from SAM Local (aws#587)

* docs(README): Update sample code for calling Local Lambda Invoke (aws#584)

* refactor(init): renamed handler for camel case, moved callback call up (aws#586)

* chore: aws-lambda-java-core 1.1.0 -> 1.2.0 for java sam init (aws#578)

* feat(validate): Add profile and region options (aws#582)

Currently, `sam validate` requires AWS Creds (due to the SAM Translator).
This commits adds the ability to pass in the credientials through a profile
that is configured through `aws configure`.

* docs(README): Update README prerequisites to include awscli (aws#596)

* fix(start-lambda): Remove Content-Type Header check (aws#594)

* docs: Disambiguation "Amazon Kinesis" (aws#599)

* docs: Adding instructions for how to add pyenv to your PATH for Windows (aws#600)

* docs: Update README with small grammar fix (aws#601)

* fix: Update link in NodeJS package.json (aws#603)

* docs: Creating instructions for Windows users to install sam (aws#605)

* docs: Adding a note directing Windows users to use pipenv (aws#606)

* fix: Fix stringifying λ environment variables when using Python2 (aws#579)

* feat(generate-event): Added support for 50+ events (aws#612)

* feat(invoke): Add region parameter to all invoke related commands (aws#608)

* docs: Breaking up README into separate files to make it easier to read (aws#607)

* chore: Update JVM size params to match docker-lambda (aws#615)

* feat(invoke): Invoke Function Without Parameters through --no-event (aws#604)

* docs: Update advanced_usage.rst with clarification on --env-vars usage (aws#610)

* docs: Remove an extra word in the sam packaging command (aws#618)

* UX: Improves event names to reflect Lambda Event Sources (aws#619)

* docs: Fix git clone typo in installation docs (aws#630)

* docs(README): Callout go1.x runtime support (aws#631)

* docs(installation): Update sam --version command (aws#634)

* chore(0.6.0): SAM CLI Version bump (aws#635)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants