Skip to content

Commit 32a2736

Browse files
authored
Merge branch 'main' into feat/add_renovate_settings
2 parents c6faae6 + 7d04bda commit 32a2736

File tree

7 files changed

+40
-21
lines changed

7 files changed

+40
-21
lines changed

CHANGELOG.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# ReleaseVersions - Changelog
2+
3+
## 2024-06
4+
5+
Version 3.0.0
6+
7+
- Initiate CHANGELOG-file
8+
- Overhaul of "HowTo" in README.md
9+
- Cleaned-up repository
10+
- Fixed .github workflows
11+
- Fixed template folder-structure
12+
- Updated to SDK2405 release package versions

CODEOWNERS

Lines changed: 0 additions & 4 deletions
This file was deleted.

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,13 @@ apax create @simatic-ax/app --registry https://npm.pkg.github.com
1818
app
1919
|
2020
+- .github
21-
| | # default GitHub workflows any gh-community-scope app-repo should have (ignore)
22-
| +- lint-repo.yml
23-
| +- release-applicationexample.yml
21+
| | # default GitHub workflows any gh-community-scope app-repo should have (ignore)
22+
| +- lint-repo.yml
23+
| +- release-applicationexample.yml
2424
|
2525
+- docs
26-
| | # the place for additional user-documentation
27-
| +- app.md
26+
| | # the place for additional user-documentation
27+
| +- app.md
2828
|
2929
+- src
3030
| | # adjust and add user-programs here
@@ -51,7 +51,7 @@ app
5151
| # essential git project files, pls. adjust
5252
+- CODEOWNERS
5353
+- README.md
54-
+- LICENSE.md
54+
+- LICENSE.md #do not change!
5555
```
5656

5757
## Create an `application example` repository with this apax-template on GitHub

template/CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Changelog
2+
3+
## yyyy-mm-dd
4+
5+
Version 0.0.1
6+
7+
- First Version

template/CODEOWNERS

Lines changed: 0 additions & 4 deletions
This file was deleted.

template/README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# @simatic-ax/apax-package-name-d7b4b031
22

3-
## What is this application doing?
3+
## Description
44

55
> This README.md was generated by a template.
66
> Please adjust/complete ...
77
8-
## Install the application example and open it locally
8+
## Create a new project with this application example
99

1010
Example Text:
1111

@@ -50,10 +50,18 @@ Example Text:
5050
> This README.md was generated by a template.
5151
> Please adjust/complete ...
5252
53-
## Further information
53+
## Contribution
5454
55-
> This README.md was generated by a template.
56-
> Please adjust/complete ...
55+
Thanks for your interest in contributing. Anybody is free to report bugs, unclear documentation, and other problems regarding this repository in the Issues section or, even better, its free to propose any changes to this repository using Merge Requests.
56+
57+
## Markdownlint-cli
58+
59+
This workspace will be checked by the [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli) (there is also documented ho to install the tool) tool in the CI workflow automatically.
60+
To avoid, that the CI workflow fails because of the markdown linter, you can check all markdown files locally by running the markdownlint with:
61+
62+
```sh
63+
markdownlint **/*.md --fix
64+
```
5765

5866
## License and Legal information
5967

template/apax.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@ installStrategy: strict
2222
apaxVersion: 3.2.1
2323
# Dependencies
2424
devDependencies:
25-
"@ax/sdk": 2405.0.0
25+
"@ax/sdk": 2411.1.0
2626
"@simatic-ax/snippetscollection": 1.0.0
2727
dependencies:
28-
"@ax/system": 9.0.12 # this is an example lib-dependency for your code, pls. adjust
28+
"@ax/system": 8.0.7 # this is an example lib-dependency for your code, pls. adjust
2929

3030
# Project variables
3131
variables:

0 commit comments

Comments
 (0)