Add README for .NET #1420

alexandrevicenzi · 2024-07-16T12:55:57Z

This is related to #993.

github-actions · 2024-07-16T12:56:46Z

Created a staging project on OBS for Tumbleweed: home:defolos:BCI:Staging:Tumbleweed:Tumbleweed-1420
Changes pushed to branch Tumbleweed-1420 as commit a39c3234b946ad817c2a9b4f37d49477405b854e
Build succeeded ✅

Build Results

Repository images in home:defolos:BCI:Staging:Tumbleweed:Tumbleweed-1420 for x86_64: current state: published
Build results:

package name	status	build log
kiwi-image	⛔ excluded	live log

Repository images in home:defolos:BCI:Staging:Tumbleweed:Tumbleweed-1420 for aarch64: current state: published
Build results:

package name	status	build log
kiwi-image	⛔ excluded	live log

Repository containerfile in home:defolos:BCI:Staging:Tumbleweed:Tumbleweed-1420 for x86_64: current state: published
Build results:

package name	status	build log
kiwi-image	✅ succeeded	live log

Repository containerfile in home:defolos:BCI:Staging:Tumbleweed:Tumbleweed-1420 for aarch64: current state: published
Build results:

package name	status	build log
kiwi-image	✅ succeeded	live log

Build succeeded ✅

To run BCI-tests against this PR, use the following command:

OS_VERSION=tumbleweed TARGET=custom BASEURL=registry.opensuse.org/home/defolos/bci/staging/tumbleweed/tumbleweed-1420/ tox -- -n auto

The following images can be pulled from the staging project:

registry.opensuse.org/home/defolos/bci/staging/tumbleweed/tumbleweed-1420/containerfile/opensuse/bci/kiwi

⚠️

⚠️ Project and Branch have been deleted ⚠️

⚠️

⚠️ Project and Branch have been deleted ⚠️

⚠️

⚠️ Project and Branch have been deleted ⚠️

⚠️

alexandrevicenzi · 2024-07-16T12:56:56Z

src/dotnet/updater.py

@@ -393,7 +383,7 @@ def _is_latest_dotnet(version: _DOTNET_VERSION_T, os_version: OsVersion) -> bool
                os_version=os_version,
                version=ver,
                name="dotnet-sdk",
-                pretty_name=f".Net {ver} SDK",
+                pretty_name=f".NET SDK {ver}",


before anyone asks, these are the official names and case styling used by Microsoft.

github-actions · 2024-07-16T12:57:30Z

Created a staging project on OBS for 6: home:defolos:BCI:Staging:SLE-15-SP6:6-1420
Changes pushed to branch 6-1420 as commit 2821eb726767f995b5bbc9f41a6fce4c83db33b2
Build succeeded ✅

Build Results

Repository images in home:defolos:BCI:Staging:SLE-15-SP6:6-1420 for x86_64: current state: published
Build results:

package name	status	build log
aspnet-runtime-6.0	⛔ excluded	live log
aspnet-runtime-8.0	⛔ excluded	live log
dotnet-6.0	⛔ excluded	live log
dotnet-8.0	⛔ excluded	live log
dotnet-runtime-6.0	⛔ excluded	live log
dotnet-runtime-8.0	⛔ excluded	live log

Repository images in home:defolos:BCI:Staging:SLE-15-SP6:6-1420 for aarch64: current state: published
Build results:

package name	status	build log
aspnet-runtime-6.0	⛔ excluded	live log
aspnet-runtime-8.0	⛔ excluded	live log
dotnet-6.0	⛔ excluded	live log
dotnet-8.0	⛔ excluded	live log
dotnet-runtime-6.0	⛔ excluded	live log
dotnet-runtime-8.0	⛔ excluded	live log

Repository images in home:defolos:BCI:Staging:SLE-15-SP6:6-1420 for s390x: current state: published
Build results:

package name	status	build log
aspnet-runtime-6.0	⛔ excluded	live log
aspnet-runtime-8.0	⛔ excluded	live log
dotnet-6.0	⛔ excluded	live log
dotnet-8.0	⛔ excluded	live log
dotnet-runtime-6.0	⛔ excluded	live log
dotnet-runtime-8.0	⛔ excluded	live log

Repository images in home:defolos:BCI:Staging:SLE-15-SP6:6-1420 for ppc64le: current state: published
Build results:

package name	status	build log
aspnet-runtime-6.0	⛔ excluded	live log
aspnet-runtime-8.0	⛔ excluded	live log
dotnet-6.0	⛔ excluded	live log
dotnet-8.0	⛔ excluded	live log
dotnet-runtime-6.0	⛔ excluded	live log
dotnet-runtime-8.0	⛔ excluded	live log

Repository containerfile in home:defolos:BCI:Staging:SLE-15-SP6:6-1420 for x86_64: current state: published
Build results:

package name	status	build log
aspnet-runtime-6.0	✅ succeeded	live log
aspnet-runtime-8.0	✅ succeeded	live log
dotnet-6.0	✅ succeeded	live log
dotnet-8.0	✅ succeeded	live log
dotnet-runtime-6.0	✅ succeeded	live log
dotnet-runtime-8.0	✅ succeeded	live log

Repository containerfile in home:defolos:BCI:Staging:SLE-15-SP6:6-1420 for aarch64: current state: published
Build results:

package name	status	build log
aspnet-runtime-6.0	⛔ excluded	live log
aspnet-runtime-8.0	⛔ excluded	live log
dotnet-6.0	⛔ excluded	live log
dotnet-8.0	⛔ excluded	live log
dotnet-runtime-6.0	⛔ excluded	live log
dotnet-runtime-8.0	⛔ excluded	live log

Repository containerfile in home:defolos:BCI:Staging:SLE-15-SP6:6-1420 for s390x: current state: published
Build results:

package name	status	build log
aspnet-runtime-6.0	⛔ excluded	live log
aspnet-runtime-8.0	⛔ excluded	live log
dotnet-6.0	⛔ excluded	live log
dotnet-8.0	⛔ excluded	live log
dotnet-runtime-6.0	⛔ excluded	live log
dotnet-runtime-8.0	⛔ excluded	live log

Repository containerfile in home:defolos:BCI:Staging:SLE-15-SP6:6-1420 for ppc64le: current state: published
Build results:

package name	status	build log
aspnet-runtime-6.0	⛔ excluded	live log
aspnet-runtime-8.0	⛔ excluded	live log
dotnet-6.0	⛔ excluded	live log
dotnet-8.0	⛔ excluded	live log
dotnet-runtime-6.0	⛔ excluded	live log
dotnet-runtime-8.0	⛔ excluded	live log

Build succeeded ✅

To run BCI-tests against this PR, use the following command:

OS_VERSION=15.6 TARGET=custom BASEURL=registry.opensuse.org/home/defolos/bci/staging/sle-15-sp6/6-1420/ tox -- -n auto

The following images can be pulled from the staging project:

registry.opensuse.org/home/defolos/bci/staging/sle-15-sp6/6-1420/containerfile/bci/dotnet-aspnet
registry.opensuse.org/home/defolos/bci/staging/sle-15-sp6/6-1420/containerfile/bci/dotnet-runtime
registry.opensuse.org/home/defolos/bci/staging/sle-15-sp6/6-1420/containerfile/bci/dotnet-sdk

dcermak

The readme is missing the standard footer & header.

Also, would it make it sense to have separate templates for the images? The current template looks more like three templates with a bit of common content.

src/dotnet/README.md.j2

dirkmueller · 2024-07-17T08:51:30Z

src/dotnet/updater.py

@@ -408,7 +398,7 @@ def _is_latest_dotnet(version: _DOTNET_VERSION_T, os_version: OsVersion) -> bool
                version=ver,
                name="dotnet-runtime",
                is_sdk=False,
-                pretty_name=f".NET {ver} runtime",
+                pretty_name=f".NET Runtime {ver}",


we use sentence style capitalization here and "runtime" suffix is used elsewhere. why do we need to change this?

these are the official names and case styling used by Microsoft.

@dmpop or @lvicoun can you advise what is best here?

dirkmueller · 2024-07-17T08:51:39Z

src/dotnet/updater.py

@@ -432,7 +422,7 @@ def _is_latest_dotnet(version: _DOTNET_VERSION_T, os_version: OsVersion) -> bool
                os_version=os_version,
                name="dotnet-aspnet",
                is_sdk=False,
-                pretty_name=f"ASP.NET {ver} runtime",
+                pretty_name=f"ASP.NET Core Runtime {ver}",


we use sentence style capitalization here

these are the official names and case styling used by Microsoft.

See this for example https://dotnet.microsoft.com/en-us/download/dotnet/8.0

I don't see a reason to use lowercase on the package name, we don't call Apache tomcat, ASP.NET Core Runtime is the entire name, so the image would still be "ASP.NET Core Runtime container image".

@dmpop or @lvicoun can you advise what is best here?

Easy: follow the capitalization used in the official product name. 😄

dirkmueller · 2024-07-17T08:55:04Z

src/dotnet/README.md.j2

+To compile and deploy an application, copy the sources and build the binary:
+
+```Dockerfile
+FROM registry.suse.com/bci/dotnet-sdk:{{ image.version }} AS build


can we avoid hardcoding the registry reference here?

sure, what is the best approach?

I changed to use the registry variable.

alexandrevicenzi · 2024-07-17T09:01:58Z

The readme is missing the standard footer & header.

Yes, because .NET does not belong in bci_build. I have no way of reusing templates from there and I would need to duplicate it, create some hackery, or move .NET into bci_build as a package like others.

What do you suggest @dcermak @dirkmueller?

Also, would it make it sense to have separate templates for the images? The current template looks more like three templates with a bit of common content.

Yes, it could be split, but again, it needs a bit more hackery to get it working, unless it becomes a bci_build package.

dcermak · 2024-07-17T12:39:54Z

The readme is missing the standard footer & header.

Yes, because .NET does not belong in bci_build. I have no way of reusing templates from there and I would need to duplicate it, create some hackery, or move .NET into bci_build as a package like others.

What do you suggest @dcermak @dirkmueller?

I haven't tried this, but I think the following should work:

move the template to src/bci_build/package/dotnet-sdk/README.md.j2
symlink src/bci_build/package/dotnet-{runtime,aspnet}/README.md.j2 to the first template

then the standard readme reading code should pick it up and you should have access to additional footer & headers.

Also, would it make it sense to have separate templates for the images? The current template looks more like three templates with a bit of common content.

Yes, it could be split, but again, it needs a bit more hackery to get it working, unless it becomes a bci_build package.

I don't think that you need to have it in the bci_build package for the template reader to pick it up.

alexandrevicenzi · 2024-07-23T12:10:47Z

@dcermak no hackery needed. It seems that the template is picked from the correct place. I also split into multiple templates and created a few partials to be imported where text was duplicated.

src/bci_build/package/dotnet-sdk/README.md.j2

changes were adressed

src/bci_build/package/dotnet-aspnet/README.md.j2

src/bci_build/package/dotnet-runtime/README.md.j2

src/bci_build/package/dotnet-sdk/README.md.j2

src/bci_build/package/templates/dotnet_globalization.j2

src/bci_build/package/templates/dotnet_notice.j2

dmpop · 2024-07-24T10:47:27Z

src/dotnet/updater.py

@@ -432,7 +422,7 @@ def _is_latest_dotnet(version: _DOTNET_VERSION_T, os_version: OsVersion) -> bool
                os_version=os_version,
                name="dotnet-aspnet",
                is_sdk=False,
-                pretty_name=f"ASP.NET {ver} runtime",
+                pretty_name=f"ASP.NET Core Runtime {ver}",


Easy: follow the capitalization used in the official product name. 😄

alexandrevicenzi requested review from dmpop, dirkmueller, lvicoun and dcermak July 16, 2024 12:55

dcermak pushed a commit that referenced this pull request Jul 16, 2024

Test build for #1420

a39c323

dcermak pushed a commit that referenced this pull request Jul 16, 2024

Test build for #1420

dfd310e

alexandrevicenzi commented Jul 16, 2024

View reviewed changes

dcermak previously requested changes Jul 16, 2024

View reviewed changes

dirkmueller reviewed Jul 17, 2024

View reviewed changes

dirkmueller requested changes Jul 17, 2024

View reviewed changes

alexandrevicenzi force-pushed the dotnet-readme branch from 5656e7a to f6916f8 Compare July 23, 2024 12:08

alexandrevicenzi requested review from dirkmueller and dcermak July 23, 2024 12:09

dcermak pushed a commit that referenced this pull request Jul 23, 2024

Test build for #1420

3641ca6

dcermak reviewed Jul 24, 2024

View reviewed changes

src/bci_build/package/dotnet-sdk/README.md.j2 Outdated Show resolved Hide resolved

dmpop reviewed Jul 24, 2024

View reviewed changes

alexandrevicenzi mentioned this pull request Jul 24, 2024

Add proper README to images #993

Open

17 tasks

dcermak pushed a commit that referenced this pull request Jul 24, 2024

Test build for #1420

7eadedc

Add README for .NET

9f5c9a1

alexandrevicenzi force-pushed the dotnet-readme branch from db138d2 to 9f5c9a1 Compare July 24, 2024 14:07

dcermak pushed a commit that referenced this pull request Jul 24, 2024

Test build for #1420

2821eb7

alexandrevicenzi requested a review from dcermak July 24, 2024 14:08

dcermak approved these changes Jul 25, 2024

View reviewed changes

dcermak merged commit e9d95a5 into main Jul 25, 2024
7 checks passed

dcermak deleted the dotnet-readme branch July 25, 2024 14:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add README for .NET #1420

Add README for .NET #1420

alexandrevicenzi commented Jul 16, 2024

github-actions bot commented Jul 16, 2024 •

edited

Loading

alexandrevicenzi Jul 16, 2024

github-actions bot commented Jul 16, 2024 •

edited

Loading

dcermak left a comment

dirkmueller Jul 17, 2024

alexandrevicenzi Jul 17, 2024

alexandrevicenzi Jul 23, 2024

dirkmueller Jul 17, 2024

alexandrevicenzi Jul 17, 2024

alexandrevicenzi Jul 17, 2024

alexandrevicenzi Jul 23, 2024

dmpop Jul 24, 2024

dirkmueller Jul 17, 2024

alexandrevicenzi Jul 17, 2024

alexandrevicenzi Jul 23, 2024

alexandrevicenzi commented Jul 17, 2024

dcermak commented Jul 17, 2024

alexandrevicenzi commented Jul 23, 2024

dmpop Jul 24, 2024

Add README for .NET #1420

Add README for .NET #1420

Conversation

alexandrevicenzi commented Jul 16, 2024

github-actions bot commented Jul 16, 2024 • edited Loading

Choose a reason for hiding this comment

github-actions bot commented Jul 16, 2024 • edited Loading

dcermak left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alexandrevicenzi commented Jul 17, 2024

dcermak commented Jul 17, 2024

alexandrevicenzi commented Jul 23, 2024

Choose a reason for hiding this comment

github-actions bot commented Jul 16, 2024 •

edited

Loading

github-actions bot commented Jul 16, 2024 •

edited

Loading