Skip to content

Conversation

@theBadT
Copy link
Member

@theBadT theBadT commented Mar 4, 2025

No description provided.

@theBadT theBadT self-assigned this Mar 11, 2025
@theBadT
Copy link
Member Author

theBadT commented Mar 12, 2025

we'll keep Simatic.Ax as namespace suggestion

@theBadT
Copy link
Member Author

theBadT commented Mar 12, 2025

use Simatic.Ax namespace
offer folder structure inside template

@theBadT
Copy link
Member Author

theBadT commented Mar 12, 2025

use Simatic.Ax namespace offer folder structure inside template

done

If you want to create a new application inside the GitHub community, you may use this apax template by entering the following command in the terminal:

```bash
apax create @simatic-ax/app --registry https://npm.pkg.github.com
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
apax create @simatic-ax/app --registry https://npm.pkg.github.com
apax create @simatic-ax/template-app --registry https://npm.pkg.github.com

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just realized that this has to be corrected also in the template-lib readme

Copy link
Member

@sjuergen sjuergen Mar 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nope: 'apax create @simatic-ax/app' is correct

apax create @simatic-ax/app --registry https://npm.pkg.github.com
```

## Folder-structure of this "app" apax-template
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Folder-structure of this "app" apax-template
## Folder-structure of this "template-app" apax-template

| |- package-development-workflow.yml
| |- package-release-workflow.yml
|
+-- template # the content that is going to be installed when using @simatic-ax/app during an apax create
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
+-- template # the content that is going to be installed when using @simatic-ax/app during an apax create
+-- template # the content that is going to be installed when using @simatic-ax/template-app during an apax create

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@simatic-ax/app is correct

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mh ... are you sure ?

@simatic-ax/app works, but it will be changed to @simatic-ax/template-app automatically when executing the create command.

Look :
image

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the past the prefix template- was required for the package name. And not in the create command. 100% sure. Let's clarify if, what and when it has changed

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please add following into the apax.yml (not the apax.yml in the template folder)

keywords:

  • "template"

Copy link
Member Author

@theBadT theBadT Mar 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've spoken with the colleagues. The keyword app is exclusively occupied by the SIMATIC AX apax template. From the beginning, they've implemented an automatism, that would prefix any template name with template- during the apax create process, such that collisions with apax create app aren't happening. Given their response the current behavior (renaming app to template-app during apax create) is correct.

Copy link
Member

@BeckerStS BeckerStS Apr 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

okay, renaming behaviour is correct (comfort implementation) ... but what is our decision now ?

When it comes down to documentation it may be feels "strange/confusing" talking about "app" although the actual used name is "template-app".

FYI: added the keyword section as jürgen stated

@theBadT theBadT merged commit 3d33f27 into main Apr 28, 2025
2 checks passed
@theBadT theBadT deleted the incorporate-new-actions branch April 28, 2025 08:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants