Skip to content

Commit

Permalink
Merge branch 'release-1.29.80'
Browse files Browse the repository at this point in the history
* release-1.29.80:
  Bumping version to 1.29.80
  Update changelog based on model updates
  Extend docutils line length limit
  • Loading branch information
aws-sdk-python-automation committed Nov 7, 2023
2 parents daa2b2a + 3ac3f94 commit 7a87e34
Show file tree
Hide file tree
Showing 8 changed files with 68 additions and 7 deletions.
27 changes: 27 additions & 0 deletions .changes/1.29.80.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
[
{
"category": "``help``",
"description": "Relax line length limit for rendered ``help`` pages",
"type": "bugfix"
},
{
"category": "``dataexchange``",
"description": "Updated SendDataSetNotificationRequest Comment to be maximum length 4096.",
"type": "api-change"
},
{
"category": "``dlm``",
"description": "Added support for pre and post scripts in Amazon Data Lifecycle Manager EBS snapshot lifecycle policies.",
"type": "api-change"
},
{
"category": "``rds``",
"description": "This Amazon RDS release adds support for the multi-tenant configuration. In this configuration, an RDS DB instance can contain multiple tenant databases. In RDS for Oracle, a tenant database is a pluggable database (PDB).",
"type": "api-change"
},
{
"category": "``endpoint-rules``",
"description": "Update endpoint-rules command to latest version",
"type": "api-change"
}
]
10 changes: 10 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,16 @@
CHANGELOG
=========

1.29.80
=======

* bugfix:``help``: Relax line length limit for rendered ``help`` pages
* api-change:``dataexchange``: Updated SendDataSetNotificationRequest Comment to be maximum length 4096.
* api-change:``dlm``: Added support for pre and post scripts in Amazon Data Lifecycle Manager EBS snapshot lifecycle policies.
* api-change:``rds``: This Amazon RDS release adds support for the multi-tenant configuration. In this configuration, an RDS DB instance can contain multiple tenant databases. In RDS for Oracle, a tenant database is a pluggable database (PDB).
* api-change:``endpoint-rules``: Update endpoint-rules command to latest version


1.29.79
=======

Expand Down
2 changes: 1 addition & 1 deletion awscli/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
"""
import os

__version__ = '1.29.79'
__version__ = '1.29.80'

#
# Get our data path to be added to botocore's search path
Expand Down
21 changes: 18 additions & 3 deletions awscli/help.py
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,16 @@ def __init__(self, output_stream=sys.stdout):
self.output_stream = output_stream

PAGER = None
_DEFAULT_DOCUTILS_SETTINGS_OVERRIDES = {
# The default for line length limit in docutils is 10,000. However,
# currently in the documentation, it inlines all possible enums in
# the JSON syntax which exceeds this limit for some EC2 commands
# and prevents the manpages from being generated.
# This is a temporary fix to allow the manpages for these commands
# to be rendered. Long term, we should avoid enumerating over all
# enums inline for the JSON syntax snippets.
'line_length_limit': 50_000
}

def get_pager_cmdline(self):
pager = self.PAGER
Expand Down Expand Up @@ -105,7 +115,10 @@ class PosixHelpRenderer(PagingHelpRenderer):
PAGER = 'less -R'

def _convert_doc_content(self, contents):
man_contents = publish_string(contents, writer=manpage.Writer())
man_contents = publish_string(
contents, writer=manpage.Writer(),
settings_overrides=self._DEFAULT_DOCUTILS_SETTINGS_OVERRIDES,
)
if self._exists_on_path('groff'):
cmdline = ['groff', '-m', 'man', '-T', 'ascii']
elif self._exists_on_path('mandoc'):
Expand Down Expand Up @@ -154,8 +167,10 @@ class WindowsHelpRenderer(PagingHelpRenderer):
PAGER = 'more'

def _convert_doc_content(self, contents):
text_output = publish_string(contents,
writer=TextWriter())
text_output = publish_string(
contents, writer=TextWriter(),
settings_overrides=self._DEFAULT_DOCUTILS_SETTINGS_OVERRIDES,
)
return text_output

def _popen(self, *args, **kwargs):
Expand Down
2 changes: 1 addition & 1 deletion doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@
# The short X.Y version.
version = '1.29.'
# The full version, including alpha/beta/rc tags.
release = '1.29.79'
release = '1.29.80'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ universal = 0

[metadata]
requires_dist =
botocore==1.31.79
botocore==1.31.80
docutils>=0.10,<0.17
s3transfer>=0.7.0,<0.8.0
PyYAML>=3.10,<6.1
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ def find_version(*file_paths):


install_requires = [
'botocore==1.31.79',
'botocore==1.31.80',
'docutils>=0.10,<0.17',
's3transfer>=0.7.0,<0.8.0',
'PyYAML>=3.10,<6.1',
Expand Down
9 changes: 9 additions & 0 deletions tests/functional/docs/test_help_output.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
from awscli.testutils import BaseAWSHelpOutputTest
from awscli.testutils import FileCreator
from awscli.testutils import mock
from awscli.testutils import aws

from awscli.compat import six
from awscli.alias import AliasLoader
Expand Down Expand Up @@ -482,3 +483,11 @@ def test_service_help_command_has_note(self):
self.driver.main(['s3api', 'get-object', 'help'])
self.assert_not_contains('outfile <value>')
self.assert_contains('<outfile>')


# Use this test class for "help" cases that require the default renderer
# (i.e. renderer from get_render()) instead of a mocked version.
class TestHelpOutputDefaultRenderer:
def test_line_lengths_do_not_break_create_launch_template_version_cmd(self):
result = aws('ec2 create-launch-template-version help')
assert 'exceeds the line-length-limit' not in result.stderr

0 comments on commit 7a87e34

Please sign in to comment.