Skip to content

Commit

Permalink
change dev versions to 0.1.0 workaround for tests
Browse files Browse the repository at this point in the history
  • Loading branch information
PTKu committed Apr 15, 2024
1 parent 781f698 commit 8efdb5e
Show file tree
Hide file tree
Showing 113 changed files with 402 additions and 402 deletions.
2 changes: 1 addition & 1 deletion docs/README.html
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ <h3 id="src"><strong>src</strong></h3>
<h2 id="apax-package-versions">APAX Package Versions</h2>
<div class="IMPORTANT">
<h5>Important</h5>
<p>All apax packages on the default branch (dev) have a fixed version '0.0.0-dev.0'. This version must not be changed by any commit.
<p>All apax packages on the default branch (dev) have a fixed version '0.1.0'. This version must not be changed by any commit.
The version is assigned at build time in the CI/CD pipeline.</p>
</div>
<h2 id="central-package-management-system">Central Package Management System</h2>
Expand Down
2 changes: 1 addition & 1 deletion docs/index.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"README.html": {
"href": "README.html",
"title": "About this Repository | System.Dynamic.ExpandoObject",
"keywords": "About this Repository Pre-requisites APAX 2.0.0 AXCODE DOTNET 6.0, 7.0 VSCODE or VS2022 Add package source To get access to the packages from AX# and AXOpen you will need to authenticate to a dedicated package feed hosted on GitHub. Authentication is free. If you do not have a GitHub account please consider creating one by signing up at https://github.com. dotnet nuget add source --username GITHUBUSERNAME --password PAT --store-password-in-clear-text --name gh-packages-ix-ax \"https://nuget.pkg.github.com/ix-ax/index.json\" Replace GITHUBUSERNAME with your github name Replace PAT with your Personal Access Token (how to create your PAT) Checking pre-requisites using script To check pre-requisites in your enviroment run check_requisites.ps1 script. # cd into your `axopen` folder .\\scripts\\check_requisites.ps1 Build this repository In order to build this repostory run build.ps1 script. # cd into your `axopen` folder .\\build.ps1 Directory Structure docfx Contains documentation for this repository. docfx/ │ ├── api/ │ └── API for .NET part of the framework (autogenerated from code) │ ├── apictlr/ │ └── API for controller part of the framework (autogenerated from code) │ ├── apidoc/ │ └── Table of contents for API documentation │ ├── articles/ │ └── Various articles │ ├── components/ │ ├── Documentation for components │ └── toc.yml (new component library doc ref needs to be added here) │ ├── framework/ │ ├── Documentation for framework │ └── toc.yml (new framework library doc ref needs to be added here) │ ├── images/ │ └── Icons and images (some are used in articles) │ └── templates/ └── Documentation site templates Note When adding a new library, update components/toc.yml for components and framework/toc.yml for framework libraries manually. To test the documentation, run the following script from the repository root folder: .\\scripts\\build_test_docu.ps1 It will create docs-test folder that is git-ignored. docs The docs folder contains the documentation site. It should be generated on the appropriate branch used to publish the documentation. Important Never commit changes to the docs directory! scripts Contains various scripts. src Contains all source code related to AXOpen. Each library is placed in a separate directory which has: library/ │ ├── app/ │ └── Sandbox for testing the library, integration tests, and documentation code (linked to the library's actual documentation) │ ├── ctrl/ │ ├── src/ # Library source code │ ├── tests/ # Unit tests │ └── docs/ # (optional) Controller code documentation │ ├── src/ # .NET twin and Blazor twin │ ├── tests/ # Tests of various levels │ ├── docs/ # Library documentation │ ├── this.proj # Traversal project. Use to create a solution file for this library [see](README.md#creating-solution-file-from-traversal-project-file) │ └── slngen.ps # Generates solution file from `this.proj` APAX Package Versions Important All apax packages on the default branch (dev) have a fixed version '0.0.0-dev.0'. This version must not be changed by any commit. The version is assigned at build time in the CI/CD pipeline. Central Package Management System This project's NuGet packages versions are organized centrally. You shouldn't assign a package version in your project file. In exceptional cases, you can use a version override. Actual versions are defined in src/Directory.Packages.props. For more information on central package management, visit here. Directory-Based Build Some build aspects of all .NET projects are defined in src/Directory.Build.props. Learn more here. Creating Solution File from Traversal Project File You will find several traversal *.proj files. These are used in the CI/CD process in place of solution *.sln files. To create solution files from traversal files, use: dotnet slngen [traversal-project-name].proj -o [output-solution-file].sln --folders true --launch false Important Re-create your solution whenever the repository changes to refresh newly added, removed, or modified projects. You can then open the solution file in Visual Studio as needed. Creating a New Library from Template Use script Run the following script from the repository root folder: .\\scripts\\create_template_library.ps1 -OutputDirectory OutputFolder -ProjectNamespace Project.Namespace For example: .\\scripts\\create_template_library.ps1 -OutputDirectory components.elements -ProjectNamespace AXOpen.Components.Elements Manual create Navigate to the src/ folder of this repository. Run the following command to update the library template: dotnet new install .\\template.axolibrary\\ --force Create a library template using: dotnet new axolibrary -o OutputFolder -p ProjectName For example: dotnet new axolibrary -o components.elements -p AXOpen.Components.Elements Note Make sure you run apax install -L and apax build after new library is created. Important Ensure you run all commands from the src folder of the repository. The -o OutputFolder parameter must be within the src folder. Important The -p ProjectName parameter must contain ONLY alphanumeric characters and dots. Otherwise, inconsistencies may occur. Creating an AXOpen Application Scaffolding the application in AXOpen repository Introduction When developing new applications using the AXOpen framework, there are multiple avenues developers can consider. The script described here provides path to one of the methods, and it's a preferred choice for AXOpen contributors. This technique grants developers the privilege of working directly with the AXOpen framework's source code. Leveraging this script ensures a streamlined process of scaffolding new applications, integrating them with the AXOpen Source Repository, and maintaining them in a dedicated directory. It's important to recognize, however, that directly interacting with the source repository can lead to slower compile and build times due to the overhead associated with managing the complete framework's source code. Leveraging the AXOpen Source Repository It's noteworthy that the .application directory is deliberately excluded from the source control of the primary repository. This design choice allows developers the flexibility to initiate their own repositories within this space, ensuring direct access and reference to the AXOpen library's source code. Scaffolding Your Application To begin scaffolding your application, you should run the scripts/create_application.ps1 command. Note While this script assists in setting up your application in the src/.application folder, it doesn't handle the initialization of source control for this directory. This step must be managed independently. Note Ensure that the src/.application directory is vacant before executing the script to prevent potential issues. .\\scripts\\create_application.ps1 -ProjectName MyNewProject When prompted Template is configured to run the following action: Actual command: install.cmd Do you want to run this action [Y(yes)|N(no)]? Answer Yes or revise the script and run it manually later from the target folder. Warning Please ensure you understand the implications of running scripts on your system. Follow the instruction in the README.md file."
"keywords": "About this Repository Pre-requisites APAX 2.0.0 AXCODE DOTNET 6.0, 7.0 VSCODE or VS2022 Add package source To get access to the packages from AX# and AXOpen you will need to authenticate to a dedicated package feed hosted on GitHub. Authentication is free. If you do not have a GitHub account please consider creating one by signing up at https://github.com. dotnet nuget add source --username GITHUBUSERNAME --password PAT --store-password-in-clear-text --name gh-packages-ix-ax \"https://nuget.pkg.github.com/ix-ax/index.json\" Replace GITHUBUSERNAME with your github name Replace PAT with your Personal Access Token (how to create your PAT) Checking pre-requisites using script To check pre-requisites in your enviroment run check_requisites.ps1 script. # cd into your `axopen` folder .\\scripts\\check_requisites.ps1 Build this repository In order to build this repostory run build.ps1 script. # cd into your `axopen` folder .\\build.ps1 Directory Structure docfx Contains documentation for this repository. docfx/ │ ├── api/ │ └── API for .NET part of the framework (autogenerated from code) │ ├── apictlr/ │ └── API for controller part of the framework (autogenerated from code) │ ├── apidoc/ │ └── Table of contents for API documentation │ ├── articles/ │ └── Various articles │ ├── components/ │ ├── Documentation for components │ └── toc.yml (new component library doc ref needs to be added here) │ ├── framework/ │ ├── Documentation for framework │ └── toc.yml (new framework library doc ref needs to be added here) │ ├── images/ │ └── Icons and images (some are used in articles) │ └── templates/ └── Documentation site templates Note When adding a new library, update components/toc.yml for components and framework/toc.yml for framework libraries manually. To test the documentation, run the following script from the repository root folder: .\\scripts\\build_test_docu.ps1 It will create docs-test folder that is git-ignored. docs The docs folder contains the documentation site. It should be generated on the appropriate branch used to publish the documentation. Important Never commit changes to the docs directory! scripts Contains various scripts. src Contains all source code related to AXOpen. Each library is placed in a separate directory which has: library/ │ ├── app/ │ └── Sandbox for testing the library, integration tests, and documentation code (linked to the library's actual documentation) │ ├── ctrl/ │ ├── src/ # Library source code │ ├── tests/ # Unit tests │ └── docs/ # (optional) Controller code documentation │ ├── src/ # .NET twin and Blazor twin │ ├── tests/ # Tests of various levels │ ├── docs/ # Library documentation │ ├── this.proj # Traversal project. Use to create a solution file for this library [see](README.md#creating-solution-file-from-traversal-project-file) │ └── slngen.ps # Generates solution file from `this.proj` APAX Package Versions Important All apax packages on the default branch (dev) have a fixed version '0.1.0'. This version must not be changed by any commit. The version is assigned at build time in the CI/CD pipeline. Central Package Management System This project's NuGet packages versions are organized centrally. You shouldn't assign a package version in your project file. In exceptional cases, you can use a version override. Actual versions are defined in src/Directory.Packages.props. For more information on central package management, visit here. Directory-Based Build Some build aspects of all .NET projects are defined in src/Directory.Build.props. Learn more here. Creating Solution File from Traversal Project File You will find several traversal *.proj files. These are used in the CI/CD process in place of solution *.sln files. To create solution files from traversal files, use: dotnet slngen [traversal-project-name].proj -o [output-solution-file].sln --folders true --launch false Important Re-create your solution whenever the repository changes to refresh newly added, removed, or modified projects. You can then open the solution file in Visual Studio as needed. Creating a New Library from Template Use script Run the following script from the repository root folder: .\\scripts\\create_template_library.ps1 -OutputDirectory OutputFolder -ProjectNamespace Project.Namespace For example: .\\scripts\\create_template_library.ps1 -OutputDirectory components.elements -ProjectNamespace AXOpen.Components.Elements Manual create Navigate to the src/ folder of this repository. Run the following command to update the library template: dotnet new install .\\template.axolibrary\\ --force Create a library template using: dotnet new axolibrary -o OutputFolder -p ProjectName For example: dotnet new axolibrary -o components.elements -p AXOpen.Components.Elements Note Make sure you run apax install -L and apax build after new library is created. Important Ensure you run all commands from the src folder of the repository. The -o OutputFolder parameter must be within the src folder. Important The -p ProjectName parameter must contain ONLY alphanumeric characters and dots. Otherwise, inconsistencies may occur. Creating an AXOpen Application Scaffolding the application in AXOpen repository Introduction When developing new applications using the AXOpen framework, there are multiple avenues developers can consider. The script described here provides path to one of the methods, and it's a preferred choice for AXOpen contributors. This technique grants developers the privilege of working directly with the AXOpen framework's source code. Leveraging this script ensures a streamlined process of scaffolding new applications, integrating them with the AXOpen Source Repository, and maintaining them in a dedicated directory. It's important to recognize, however, that directly interacting with the source repository can lead to slower compile and build times due to the overhead associated with managing the complete framework's source code. Leveraging the AXOpen Source Repository It's noteworthy that the .application directory is deliberately excluded from the source control of the primary repository. This design choice allows developers the flexibility to initiate their own repositories within this space, ensuring direct access and reference to the AXOpen library's source code. Scaffolding Your Application To begin scaffolding your application, you should run the scripts/create_application.ps1 command. Note While this script assists in setting up your application in the src/.application folder, it doesn't handle the initialization of source control for this directory. This step must be managed independently. Note Ensure that the src/.application directory is vacant before executing the script to prevent potential issues. .\\scripts\\create_application.ps1 -ProjectName MyNewProject When prompted Template is configured to run the following action: Actual command: install.cmd Do you want to run this action [Y(yes)|N(no)]? Answer Yes or revise the script and run it manually later from the target folder. Warning Please ensure you understand the implications of running scripts on your system. Follow the instruction in the README.md file."
},
"abstractions/app/ix-blazor/librarytemplate.blazor/wwwroot/css/open-iconic/README.html": {
"href": "abstractions/app/ix-blazor/librarytemplate.blazor/wwwroot/css/open-iconic/README.html",
Expand Down
2 changes: 1 addition & 1 deletion src/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ library/
## APAX Package Versions

> [!IMPORTANT]
> All apax packages on the default branch (dev) have a fixed version '0.0.0-dev.0'. This version must not be changed by any commit.
> All apax packages on the default branch (dev) have a fixed version '0.1.0'. This version must not be changed by any commit.
> The version is assigned at build time in the CI/CD pipeline.

Expand Down
10 changes: 5 additions & 5 deletions src/abstractions/app/apax.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: "abstractions-app"
version : '0.0.0-dev.0'
version : '0.1.0'
type: app
targets:
- plcsim
Expand All @@ -8,11 +8,11 @@ variables:
APAX_BUILD_ARGS:
- "--debug" # Generate debug information for target "1500"
devDependencies:
"@ix-ax/ax-sdk" : '0.0.0-dev.0'
"@ix-ax/ax-sdk" : '0.1.0'
dependencies:
"@ix-ax/axopen.abstractions" : '0.0.0-dev.0'
"@ix-ax/axopen.timers" : '0.0.0-dev.0'
"@ix-ax/axopen.core" : '0.0.0-dev.0'
"@ix-ax/axopen.abstractions" : '0.1.0'
"@ix-ax/axopen.timers" : '0.1.0'
"@ix-ax/axopen.core" : '0.1.0'
scripts:
download:
- apax install
Expand Down
2 changes: 1 addition & 1 deletion src/abstractions/app/axsharp.companion.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"Id":"abstractions_app","Version":"0.0.0-dev.0"}
{"Id":"abstractions_app","Version":"0.1.0"}
4 changes: 2 additions & 2 deletions src/abstractions/ctrl/apax.yml
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
name: "@ix-ax/axopen.abstractions"
version : '0.0.0-dev.0'
version : '0.1.0'
type: lib
targets:
- llvm
files:
- src
- axsharp.companion.json
devDependencies:
"@ix-ax/ax-sdk" : '0.0.0-dev.0'
"@ix-ax/ax-sdk" : '0.1.0'
dependencies:
"@ax/system-strings": ^6.0.94
scripts:
Expand Down
2 changes: 1 addition & 1 deletion src/abstractions/ctrl/axsharp.companion.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"Id":"AXOpen.Abstractions","Version":"0.0.0-dev.0"}
{"Id":"AXOpen.Abstractions","Version":"0.1.0"}
2 changes: 1 addition & 1 deletion src/apax.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@ name: "ix-ax"
version: 0.1.0
type: workspace
devDependencies:
"@ix-ax/ax-sdk": '0.0.0-dev.0'
"@ix-ax/ax-sdk": '0.1.0'
installStrategy: strict
apaxVersion: 3.1.0
14 changes: 7 additions & 7 deletions src/components.abb.robotics/app/apax.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: "app_axopen.components.abb.robotics"
version : '0.0.0-dev.0'
version : '0.1.0'
type: app
targets:
- plcsim
Expand All @@ -9,14 +9,14 @@ variables:
APAX_BUILD_ARGS:
- "--debug" # Generate debug information for target "1500"
devDependencies:
"@ix-ax/ax-sdk" : '0.0.0-dev.0'
"@ix-ax/ax-sdk" : '0.1.0'
"@ax/sld": 2.0.5
dependencies:
"@ix-ax/axopen.core" : '0.0.0-dev.0'
"@ix-ax/axopen.timers" : '0.0.0-dev.0'
"@ix-ax/axopen.abstractions" : '0.0.0-dev.0'
"@ix-ax/axopen.components.abb.robotics" : '0.0.0-dev.0'
"@ix-ax/axopen.simatic1500" : '0.0.0-dev.0'
"@ix-ax/axopen.core" : '0.1.0'
"@ix-ax/axopen.timers" : '0.1.0'
"@ix-ax/axopen.abstractions" : '0.1.0'
"@ix-ax/axopen.components.abb.robotics" : '0.1.0'
"@ix-ax/axopen.simatic1500" : '0.1.0'
"@ax/simatic-1500-clocks": ^6.0.37
scripts:
delta:
Expand Down
2 changes: 1 addition & 1 deletion src/components.abb.robotics/app/axsharp.companion.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"Id":"app_axopen_components_abb_robotics","Version":"0.0.0-dev.0"}
{"Id":"app_axopen_components_abb_robotics","Version":"0.1.0"}
16 changes: 8 additions & 8 deletions src/components.abb.robotics/ctrl/apax.yml
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
name: "@ix-ax/axopen.components.abb.robotics"
version : '0.0.0-dev.0'
version : '0.1.0'
type: lib
targets:
- llvm
files:
- src
- axsharp.companion.json
devDependencies:
"@ix-ax/ax-sdk" : '0.0.0-dev.0'
"@ix-ax/ax-sdk" : '0.1.0'
scripts:
postbuild:
- dotnet ixc
dependencies:
"@ix-ax/axopen.components.abstractions" : '0.0.0-dev.0'
"@ix-ax/axopen.core" : '0.0.0-dev.0'
"@ix-ax/axopen.timers" : '0.0.0-dev.0'
"@ix-ax/axopen.abstractions" : '0.0.0-dev.0'
"@ix-ax/axopen.components.robotics" : '0.0.0-dev.0'
"@ix-ax/axopen.io" : '0.0.0-dev.0'
"@ix-ax/axopen.components.abstractions" : '0.1.0'
"@ix-ax/axopen.core" : '0.1.0'
"@ix-ax/axopen.timers" : '0.1.0'
"@ix-ax/axopen.abstractions" : '0.1.0'
"@ix-ax/axopen.components.robotics" : '0.1.0'
"@ix-ax/axopen.io" : '0.1.0'
"@ax/simatic-1500-distributedio": ^6.0.3
publicKeys:
"@ix-ax": 30c06ef7830b4dfd8f16e003508da1ac2d187714d0e1f38279a9332cbe4e4e17
Expand Down
2 changes: 1 addition & 1 deletion src/components.abb.robotics/ctrl/axsharp.companion.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"Id":"AXOpen.Components.Abb.Robotics","Version":"0.0.0-dev.0"}
{"Id":"AXOpen.Components.Abb.Robotics","Version":"0.1.0"}
Loading

0 comments on commit 8efdb5e

Please sign in to comment.