-
Notifications
You must be signed in to change notification settings - Fork 77
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Initialize releasenotes building (#1164)
Initialize releasenotes building setup releasenotes structure to be build by sphinx&reno (same as other python otc tools) migrate content of the changelog into older releasenotes ======= RN publishing is going to be implemented separately in the job-template (bit later) PR's that have interface effect "must" contain RN note (can be generated according to https://docs.openstack.org/reno/latest/user/usage.html) PR's without external visibility "should" have RN note. it is in the reviewers responsibility to check/enforce RN presence. Generally RN can be added later, but should be done before release, cause otherwise will be related to wrong release. Reviewed-by: None <None> Reviewed-by: Rodion Gyrbu <[email protected]> Reviewed-by: Anton Kachurin <[email protected]> Reviewed-by: Artem Goncharov <[email protected]>
- Loading branch information
Showing
8 changed files
with
1,468 additions
and
0 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -27,3 +27,4 @@ localrc | |
!command/test-fixtures/**/.terraform/ | ||
|
||
dist | ||
releasenotes/build |
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
--- | ||
other: | ||
- | | ||
Initialize releasenotes building with reno. |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
reno>=3.1.0 # Apache-2.0 | ||
otcdocstheme # Apache-2.0 |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,100 @@ | ||
# Licensed under the Apache License, Version 2.0 (the "License"); | ||
# you may not use this file except in compliance with the License. | ||
# You may obtain a copy of the License at | ||
# | ||
# http://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, software | ||
# distributed under the License is distributed on an "AS IS" BASIS, | ||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or | ||
# implied. | ||
# See the License for the specific language governing permissions and | ||
# limitations under the License. | ||
|
||
import os | ||
import warnings | ||
|
||
# -- General configuration ---------------------------------------------------- | ||
|
||
# Add any Sphinx extension module names here, as strings. They can be | ||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. | ||
extensions = [ | ||
'reno.sphinxext', | ||
'otcdocstheme', | ||
] | ||
|
||
# openstackdocstheme options | ||
otcdocs_repo = 'opentelekomcloud/terraform-provider-opentelekomcloud' | ||
html_last_updated_fmt = '%Y-%m-%d %H:%M' | ||
html_theme = 'otcdocs' | ||
|
||
# TODO(shade) Set this to true once the build-openstack-sphinx-docs job is | ||
# updated to use sphinx-build. | ||
# When True, this will raise an exception that kills sphinx-build. | ||
enforcer_warnings_as_errors = False | ||
|
||
# autodoc generation is a bit aggressive and a nuisance when doing heavy | ||
# text edit cycles. | ||
# execute "export SPHINX_DEBUG=1" in your terminal to disable | ||
|
||
# General information about the project. | ||
project = u'terraform-provider-opentelekomcloud' | ||
copyright = u'2021, Various members of the OpenTelekomCloud' | ||
|
||
# A few variables have to be set for the log-a-bug feature. | ||
# gitsha: The SHA checksum of the bug description. Extracted from git log. | ||
# bug_tag: Tag for categorizing the bug. Must be set manually. | ||
# bug_project: Launchpad project to file bugs against. | ||
# These variables are passed to the logabug code via html_context. | ||
git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '" | ||
try: | ||
gitsha = os.popen(git_cmd).read().strip('\n') | ||
except Exception: | ||
warnings.warn("Can not get git sha.") | ||
gitsha = "unknown" | ||
|
||
otcdocs_bug_tag = "docs" | ||
pwd = os.getcwd() | ||
# html_context allows us to pass arbitrary values into the html template | ||
html_context = {"pwd": pwd, | ||
"gitsha": gitsha} | ||
|
||
# If true, '()' will be appended to :func: etc. cross-reference text. | ||
add_function_parentheses = True | ||
|
||
# If true, the current module name will be prepended to all description | ||
# unit titles (such as .. function::). | ||
add_module_names = True | ||
|
||
# The name of the Pygments (syntax highlighting) style to use. | ||
pygments_style = 'native' | ||
|
||
autodoc_member_order = "bysource" | ||
|
||
# Locations to exclude when looking for source files. | ||
exclude_patterns = [] | ||
|
||
# -- Options for HTML output ---------------------------------------------- | ||
|
||
# Don't let openstackdocstheme insert TOCs automatically. | ||
theme_include_auto_toc = False | ||
|
||
# Output file base name for HTML help builder. | ||
htmlhelp_basename = '%sdoc' % project | ||
|
||
# Grouping the document tree into LaTeX files. List of tuples | ||
# (source start file, target name, title, author, documentclass | ||
# [howto/manual]). | ||
latex_documents = [ | ||
('index', | ||
'%s.tex' % project, | ||
u'%s Documentation' % project, | ||
u'OpenTelekomCloud', 'manual'), | ||
] | ||
|
||
html_theme_options = { | ||
'display_toc': False, | ||
} | ||
|
||
# Include both the class and __init__ docstrings when describing the class | ||
autoclass_content = "both" |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
===================== | ||
Current Release Notes | ||
===================== | ||
|
||
.. release-notes:: | ||
|
||
1.24.2 | ||
------ | ||
|
||
New Features | ||
============ | ||
|
||
* `resource/opentelekomcloud_waf_certificate_v1`: Add possibility to configure TLS ([#1132](https://github.com/opentelekomcloud/terraform-provider-opentelekomcloud/issues/1132)) | ||
* `resource/opentelekomcloud_ecs_instance_v1`: Add possibility to encrypt `data_volumes` ([#1135](https://github.com/opentelekomcloud/terraform-provider-opentelekomcloud/issues/1135)) | ||
|
||
Bug Fixes | ||
========= | ||
|
||
* `provider`: Store temporary AK/SK in OBS client only ([#1133](https://github.com/opentelekomcloud/terraform-provider-opentelekomcloud/issues/1133)) | ||
* `resource/opentelekomcloud_rds_instance_v3`: Fix not setting `availability_zone` during import/refresh ([#1137](https://github.com/opentelekomcloud/terraform-provider-opentelekomcloud/issues/1137)) | ||
* `resource/opentelekomcloud_obs_bucket`: Fix not creating bucket for `eu-nl` region ([#1139](https://github.com/opentelekomcloud/terraform-provider-opentelekomcloud/issues/1139)) | ||
* `resource/opentelekomcloud_rds_instance_v3`: Fix configuration template applied partially ([#1150](https://github.com/opentelekomcloud/terraform-provider-opentelekomcloud/issues/1150)) | ||
|
||
Other Notes | ||
=========== | ||
|
||
* `resources/opentelekomcloud_nat_gateway_v2`: Note that `router_id` can be a VPC ID ([#1140](https://github.com/opentelekomcloud/terraform-provider-opentelekomcloud/issues/1140)) | ||
|
||
1.24.1 | ||
------ | ||
|
||
New Features | ||
============ | ||
|
||
* **New Resource:** `opentelekomcloud_swr_organization_v2` ([#1120](https://github.com/opentelekomcloud/terraform-provider-opentelekomcloud/pull/1120)) | ||
* **New Resource:** `opentelekomcloud_swr_repository_v2` ([#1123](https://github.com/opentelekomcloud/terraform-provider-opentelekomcloud/pull/1123)) | ||
* **New Resource:** `opentelekomcloud_swr_domain_v2` ([#1127](https://github.com/opentelekomcloud/terraform-provider-opentelekomcloud/pull/1127)) | ||
* **New Resource:** `opentelekomcloud_swr_organization_permissions_v2` ([#1129](https://github.com/opentelekomcloud/terraform-provider-opentelekomcloud/pull/1129)) | ||
* `resource/opentelekomcloud_waf_certificate_v1`: Add name certificate name validation ([#1116](https://github.com/opentelekomcloud/terraform-provider-opentelekomcloud/pull/1116)) | ||
* `resource/opentelekomcloud_cce_node_v3`: Add possibility to encrypt `data_volumes` ([#1117](https://github.com/opentelekomcloud/terraform-provider-opentelekomcloud/pull/1117)) | ||
* `resource/opentelekomcloud_waf_certificate_v1`: Add possibility to import by name ([#1119](https://github.com/opentelekomcloud/terraform-provider-opentelekomcloud/pull/1119)) | ||
* `resource/opentelekomcloud_obs_bucket_v1`: Add possibility to create buckets with encryption ([#1125](https://github.com/opentelekomcloud/terraform-provider-opentelekomcloud/pull/1125)) | ||
|
||
Bug Fixes | ||
========= | ||
|
||
* `resource/opentelekomcloud_as_configuration_v1`: Fix wrong SHA1 sum in `Read` operation ([#1130](https://github.com/opentelekomcloud/terraform-provider-opentelekomcloud/pull/1130)) | ||
|
||
1.24.0 | ||
------ | ||
|
||
Deprecation Notes | ||
================= | ||
|
||
* Move to `terraform-plugin-sdk/v2`, only Terraform versions `0.12+` are supported ([#1104](https://github.com/opentelekomcloud/terraform-provider-opentelekomcloud/issues/1104)) | ||
|
||
Other Notes | ||
=========== | ||
|
||
This release contains no functional differences from `1.23.13`. | ||
|
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
================================================= | ||
terraform-provider-opentelekomcloud Release Notes | ||
================================================= | ||
|
||
.. toctree:: | ||
:maxdepth: 1 | ||
|
||
current | ||
older | ||
|
Oops, something went wrong.