#67: Mentioned the AMI copy function in tutorial and release notes (#68)

fixes #67
exasol · Oct 20, 2022 · aa5c222 · aa5c222
1 parent 913f1b3
commit aa5c222
Show file tree

Hide file tree

Showing 8 changed files with 40 additions and 4 deletions.
diff --git a/doc/changes/changelog.md b/doc/changes/changelog.md
@@ -1,3 +1,4 @@
 # Changes
 
+* [0.2.0](changes_0.2.0.md)
 * [0.1.0](changes_0.1.0.md)
diff --git a/doc/changes/changes_0.2.0.md b/doc/changes/changes_0.2.0.md
@@ -0,0 +1,27 @@
+# script-languages-developer-sandbox 0.2.0, released t.b.d.
+
+Code name: t.b.d.
+
+## Summary
+
+t.b.d.
+
+## Script-Languages-Release
+
+Version: 5.0.0
+
+## Bug Fixes
+
+n/a
+
+## Features / Enhancements
+
+n/a
+
+## Documentation
+
+ - #67: Mentioned the AMI copy function in tutorial and release notes
+
+## Refactoring
+
+n/a
diff --git a/doc/user_guide/user_guide.md b/doc/user_guide/user_guide.md
@@ -45,6 +45,8 @@ We recommend the following requirements for the VM instance:
 
 ### Use the AMI
 
+__Important__: The AMI is currently only available in the AWS region `eu-central-1`. If you want to use the image in another region, you need to copy it before. Check the [AWS documentation](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/CopyingAMIs.html) for details about how to copy the image.
+
 #### Overview
 
 1. Create a Security Group with open inbound ports for `ssh` (22) and `Jupyter` (8888)

diff --git a/exasol_script_languages_developer_sandbox/lib/update_release/run_update_release.py b/exasol_script_languages_developer_sandbox/lib/update_release/run_update_release.py
@@ -5,17 +5,19 @@
 from exasol_script_languages_developer_sandbox.lib.asset_printing.print_assets import print_assets, AssetTypes
 from exasol_script_languages_developer_sandbox.lib.aws_access.aws_access import AwsAccess
 from exasol_script_languages_developer_sandbox.lib.github_release_access import GithubReleaseAccess
+from exasol_script_languages_developer_sandbox.lib.render_template import render_template
 
 
 def run_update_release(aws_access: AwsAccess, gh_access: GithubReleaseAccess,
                        release_id: int, asset_id: AssetId) -> None:
     logging.info(f"run_update_release for aws profile {aws_access.aws_profile_for_logging}")
 
+    additional_release_notes = render_template("additional_release_notes.jinja")
     with tempfile.TemporaryDirectory() as temp_dir:
         artifacts_file = f"{temp_dir}/artifacts.md"
         print_assets(aws_access, asset_id, artifacts_file,
                      (AssetTypes.AMI.value, AssetTypes.VM_S3.value))
-        content = open(artifacts_file, "r").read()
+        content = additional_release_notes + open(artifacts_file, "r").read()
         gh_access.update_release_message(release_id, content)
         gh_access.upload(archive_path=artifacts_file, label="artifacts.md",
                          release_id=release_id, content_type="text/markdown")
diff --git a/...ript_languages_developer_sandbox/runtime/ansible/roles/script_languages/defaults/main.yml b/...ript_languages_developer_sandbox/runtime/ansible/roles/script_languages/defaults/main.yml
@@ -1,6 +1,6 @@
 ---
 
 apt_dependencies:
-  - git=1:2.25.1-1ubuntu3.5
+  - git=1:2.25.1-1ubuntu3.6
 
 slc_dest_folder: "{{user_home}}/script-languages-release"
diff --git a/exasol_script_languages_developer_sandbox/templates/additional_release_notes.jinja b/exasol_script_languages_developer_sandbox/templates/additional_release_notes.jinja
@@ -0,0 +1,4 @@
+
+### AMI Region availability
+
+The AMI is currently only available in the AWS region `eu-central-1`. If you want to use the image in another region, you need to copy it before. Check the [AWS documentation](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/CopyingAMIs.html) for details about how to copy the image.
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "exasol-script-languages-developer-sandbox"
-version = "0.1.0"
+version = "0.2.0"
 description = "Manages script-languages developer virtual machines."
 
 license = "MIT"

diff --git a/setup.py b/setup.py
@@ -54,7 +54,7 @@
 
 setup_kwargs = {
     'name': 'exasol-script-languages-developer-sandbox',
-    'version': '0.1.0',
+    'version': '0.2.0',
     'description': 'Manages script-languages developer virtual machines.',
     'long_description': 'None',
     'author': 'Thomas Uebensee',
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,4 @@

		### AMI Region availability

		The AMI is currently only available in the AWS region `eu-central-1`. If you want to use the image in another region, you need to copy it before. Check the [AWS documentation](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/CopyingAMIs.html) for details about how to copy the image.