Bug/config description

[yhaliaw]

Overview

Change the yaml block scalar indicator (multi-line string formating) from | to >-.

Rationale

The current usage of | is causing formatting issues on charmhub:

https://charmhub.io/github-runner/configuration

Checklist

• The charm style guide was applied
• The contributing guide was applied
• The changes are compliant with ISD054 - Managing Charm Complexity
• The documentation is generated using src-docs
• The documentation for charmhub is updated.
• The PR is tagged with appropriate label (urgent, trivial, complex)

MERGE THIS AFTER THE OPENSTACK IMAGE.

[github-actions]

Test coverage for a8eab4e

Name                                       Stmts   Miss Branch BrPart  Cover   Missing
--------------------------------------------------------------------------------------
src/charm.py                                 473    109    107     21    75%   100-101, 103-104, 109-110, 177-179, 225-244, 259-261, 262->266, 289-293, 370-396, 429-434, 448, 469, 481-487, 501-502, 515-541, 572-573, 576->581, 615, 619-624, 664, 673->676, 690-691, 723-736, 765-770, 792, 836-837, 839-840, 842-843, 917->919, 984-985, 1018-1020, 1037
src/charm_state.py                           291     33     64     10    87%   100, 246, 272, 276-277, 297-299, 307-308, 336-337, 374-375, 381-382, 409, 414, 416, 420, 459, 471-478, 638-639, 644-645, 651-656
src/errors.py                                 42      0      0      0   100%
src/event_timer.py                            55      7      2      1    86%   103-104, 127, 144-145, 161-162
src/firewall.py                               52     18     20      0    61%   42-43, 66-69, 110-184
src/github_client.py                          93     16     40      5    78%   39-46, 94->exit, 99-100, 167, 190, 203-210, 228->263, 257
src/github_metrics.py                         14      0      0      0   100%
src/github_type.py                            50      0      0      0   100%
src/lxd_type.py                               37      0      2      0   100%
src/metrics.py                                73      2     10      1    96%   61->64, 170-171
src/metrics_type.py                            6      0      0      0   100%
src/openstack_cloud/__init__.py               22      0      2      0   100%
src/openstack_cloud/openstack_manager.py     112     13     22      0    89%   303-306, 353, 379-401
src/runner.py                                324     71     96     24    73%   46->48, 176->190, 230-231, 257-258, 299-308, 332-337, 342, 362, 366-376, 425->428, 431-433, 440, 454, 464, 468, 470, 485, 519-524, 540-553, 564-603, 608, 650, 703-705, 709, 727, 762, 788, 793-805, 819, 824->826, 829-831
src/runner_logs.py                            35      2      6      1    93%   62->61, 66-67
src/runner_manager.py                        312     56    110     13    81%   114, 156-158, 171-172, 184-186, 192-197, 201-202, 232, 275-276, 320-322, 396, 406, 432, 443-447, 472, 524-527, 559-577, 590-595, 619-621, 639-640, 738
src/runner_manager_type.py                    39      0      6      0   100%
src/runner_metrics.py                        123      8     20      2    93%   147-148, 160, 191-192, 307-311
src/runner_type.py                            32      0      8      0   100%
src/shared_fs.py                             116     16     20      0    88%   108-109, 133-134, 217-218, 241-242, 254-255, 260-261, 267-268, 292-293
src/utilities.py                              68      7     20      7    82%   74->76, 78->84, 91, 121, 135, 174-177, 228
--------------------------------------------------------------------------------------
TOTAL                                       2369    358    555     85    82%

Static code analysis report

Run started:2024-03-21 05:03:20.460226

Test results:
  No issues identified.

Code scanned:
  Total lines of code: 5274
  Total lines skipped (#nosec): 0
  Total potential issues skipped due to specifically being disabled (e.g., #nosec BXXX): 7

Run metrics:
  Total issues (by severity):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
  Total issues (by confidence):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
Files skipped (0):