diff --git a/.github/workflows/upgrade-documentation.yml b/.github/workflows/upgrade-documentation.yml index 34d0d67..5316799 100644 --- a/.github/workflows/upgrade-documentation.yml +++ b/.github/workflows/upgrade-documentation.yml @@ -6,7 +6,27 @@ on: - 'releases/*' jobs: + UML-export: + runs-on: ubuntu-latest + environment: + name: UML + steps: + - uses: actions/checkout@v2 + - name: Export UML + uses: docker://rlespinasse/drawio-export:latest + with: + args: -f svg -o ./ docs + - name: git add & commit & upload repo + continue-on-error: true + run: | + git config user.name "$GITHUB_ACTOR" + git config user.email "help@castellanidavide.it" + git add * + git commit -m "Exported UML automatically" + git push https://$GITHUB_ACTOR:${{ secrets.GITHUB_TOKEN }}@github.com/$GITHUB_REPOSITORY.git -f + upgrade-documentation: + needs: [UML-export] runs-on: ubuntu-latest environment: name: documentation @@ -57,6 +77,11 @@ jobs: if __name__ == "__main__": open("Home.md", "w+").write(str(get_content())) EOF + - name: Class UML file + run: | + cd wiki + echo "## :octocat: Class UML :octocat:" > Class-UML.md + echo "![Class UML](https://raw.githubusercontent.com/$GITHUB_REPOSITORY/$(echo ${GITHUB_REF#refs/heads/})/docs/${{ github.event.repository.name }}-Class-UML.svg)" >> Class-UML.md - name: CHANGELOG file run: | cp repo/docs/CHANGELOG.md wiki/ @@ -170,6 +195,7 @@ jobs: run: | cat wiki/_Header.md > repo/docs/README.md cat wiki/Home.md >> repo/docs/README.md + cat wiki/Class-UML.md >> repo/docs/README.md cat wiki/Directory-Structure.md >> repo/docs/README.md cat wiki/CHANGELOG.md >> repo/docs/README.md cat wiki/Rebuild-the-core-createstructure-locally.md >> repo/docs/README.md diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index 8570218..16a3647 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -2,6 +2,7 @@ Repo where there is the docker source to be run by the manager-createstructure - [Changelog](#changelog) + - [[10.01.08] - 2022-03-12](#100108---2022-03-12) - [[10.01.07] - 2022-01-05](#100107---2022-01-05) - [[10.01.06] - 2022-01-05](#100106---2022-01-05) - [[10.01.05] - 2022-01-05](#100105---2022-01-05) @@ -34,6 +35,9 @@ Repo where there is the docker source to be run by the manager-createstructure - [[09.01.01] - 2021-06-19](#090101---2021-06-19) - [Added](#added-4) +## [10.01.08] - 2022-03-12 +- [Added charts automation](https://github.com/createstructure/core-createstructure/issues/7) +- ## [10.01.07] - 2022-01-05 - [Add sponsorship button](https://github.com/createstructure/createstructure.github.io/issues/36) diff --git a/docs/README.md b/docs/README.md index c48747b..e0ea034 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,11 +1,15 @@ # core-createstructure -[![GitHub license](https://img.shields.io/badge/license-GNU-green?style=flat)](https://github.com/createstructure/core-createstructure/blob/main/docs/LICENSE) +[![GitHub license](https://img.shields.io/badge/license-GNU-green?style=flat)](https://github.com/createstructure/core-createstructure/blob/UML-beta/docs/LICENSE) ![Author](https://img.shields.io/badge/author-Castellani%20Davide-green?style=flat) ![sys.platform supported](https://img.shields.io/badge/OS%20platform%20supported-all-blue?style=flat) ## Description Repo where there's the source to create the repo(s) ![createstructure/core-createstructure](https://opengraph.githubassets.com/b1da841c688ed78dff7986086fe0203f4d84599b71a7f0bfedf24b14eb9296dc/createstructure/core-createstructure) + +## Class UML +![Class UML](https://raw.githubusercontent.com/createstructure/core-createstructure/UML-beta/docs/core-createstructure-Class-UML.svg) + ## Directory structure ``` @@ -39,7 +43,9 @@ Repo where there's the source to create the repo(s) └── docs # documentation ├── CHANGELOG.md ├── LICENSE - └── README.md + ├── README.md + ├── core-createstructure-Class-UML.svg + └── core-createstructure.drawio 6 directories, 24 files ``` @@ -47,6 +53,7 @@ Repo where there's the source to create the repo(s) Repo where there is the docker source to be run by the manager-createstructure - [ Changelog ](#changelog) + - [[10.01.08] - 2022-03-12](#100108---2022-03-12) - [[10.01.07] - 2022-01-05](#100107---2022-01-05) - [[10.01.06] - 2022-01-05](#100106---2022-01-05) - [[10.01.05] - 2022-01-05](#100105---2022-01-05) @@ -79,6 +86,9 @@ Repo where there is the docker source to be run by the manager-createstructure - [[09.01.01] - 2021-06-19](#090101---2021-06-19) - [Added](#added-4) +### [10.01.08] - 2022-03-12 +- [Added charts automation](https://github.com/createstructure/core-createstructure/issues/7) +- ### [10.01.07] - 2022-01-05 - [Add sponsorship button](https://github.com/createstructure/createstructure.github.io/issues/36) diff --git a/docs/core-createstructure-Class-UML.svg b/docs/core-createstructure-Class-UML.svg new file mode 100644 index 0000000..7254379 --- /dev/null +++ b/docs/core-createstructure-Class-UML.svg @@ -0,0 +1,2 @@ + +core+ main(argc:int, argv:char*[]):int- getFile(path.string):stringget template- username:string- token:string- data:json+ GetTemplate(repoInfo:json)+ get():string- hasEnding(original:string, ending:string):bool- ending(original:string, ending:string)+ get(repoInfo:json):stringget upload url- username:string- token:string- data: json+ GetUploadURL(repoInfo:json)+ get():string- hasEnding(original:string, ending:string):bool- ending(original:string, ending:string)+ get(repoInfo:json):stringpriority- settings:json- priority:vector<string>+ Priority(settings:json)+ execute(priorityType:string, id:int)+ execute(settings:json, priorityType:string)+ execute(settings:json, priorityType:string, id:int)repo- data:json- path:string- date:tm*- changes:vector<pair<string, string>>+ Repo(data:json)+ all(data:json)+ download(data:json)+ create(data:json)+ elaborate(data:json)+ upload(data:json)+ remove(data:json)- getDate(pattern:string):string- getChanges():vector<pair<string, string>>- getSpecialChanges():vector<pair<string, string>>- replace(original:string, changes:vector<pair<string, string>>):string- endsWith(value:string, ending:string):bool+ all()+ download()+ create()+ elaborate()+ upload()+ remove()repo info check- required:vector<string>- data:json+ RepoInfoCheck(data:json)+ check():bool+ sanitize():json+ sanitize(data:json):jsonworkload- settings:json- cryptation:Cryptation- attempts:int- ID:int- priority:bool+ Workload(settings:json)+ getWorkload():json+ setDone()+ setter(ID:int, priority:bool)- decodeWorkload(repoID:int):json- getPriority():json- getNormal():json- getNormalRepoInfo():json+ getWorkload(settings:json):json+ setDone(settings:json, ID:int, priority:bool)input check- required: vector<string>- data:json+ Inputcheck(data:json)+ check():bool+ sanitize():json+ sanitize(data:json):json
librerias-createstructure
librerias-createstructure
cryptation
cryptation
emoji
emoji
inputs
inputs
json
json
positive
positive
rest
rest
sleep
sleep
Use
Use
Use
Use
Use
Use
Use
Use
Use
Use
Use
Use
Use
Use
Use
Use
Use
Use
Use
Use
Use
Use
Use
Use
Use
Use
Use
Use
Use
Use
Use
Use
Use
Use
Use
Use
Use
Use
Use
Use
Use
Use
Use
Use
Use
Use
Use
Use
Use
Use
Use
UseViewer does not support full SVG 1.1 \ No newline at end of file diff --git a/docs/core-createstructure.drawio b/docs/core-createstructure.drawio new file mode 100755 index 0000000..72f5ce5 --- /dev/null +++ b/docs/core-createstructure.drawio @@ -0,0 +1 @@ +7V1bk5s4Gv01XdWZqqTMzcaPbfckm0lnKpvL9Oy+bClGbZNgxIDcl/z6lUDY5pO4mEbY1SYvMUKojXR0vvNdwBfWfP34LkbR6iPxcHBhjrzHC+v6wjQNY2Sz/3jLU9bijIysYRn7nui0a/ji/8KicSRaN76Hk0JHSkhA/ajYuCBhiBe00IbimDwUu92RoPhXI7TEUsOXBQrk1lvfo6v8vsbT3Yl/YX+5En/aNSfZiTXKO4s7SVbIIw97TdbvF9Y8JoRmn9aPcxzwycvn5fb9021w83P87o9/J/+gb7MPX//863U22NtDLtneQoxD2nro6V9XI4rHqw/j5L+P//vj43r2aykuGd2jYCPma0FiLO6XPuWTmDz46wCF7Gh2R0L6RZwx2DEK/GXIPi/Yd8Mxa7jHMfXZ/F+JE5RErHWx8gPvBj2RDb+DhKLFz/xotiKx/4sNiwIxJjsdUwElc1zo8YVfyZpHrDXGCevzKZ8WAzR9RI+FjjcooaJhQYIARYn/fXsbaxQv/XBGKCVr0enOD4I5CUiczoH19u10almsveFqiFXj04Ef97AoVucdJmtM4yfWRZy1xWKIjWZNxPHDHmynom21h9gcyUjslOV25B0a2AcBiAPAYUrgkIAR+CkoEhqTn9v9ZYDJC0naKUdKgO+oAidr3/OCdLAILfxw+ZXj5vq1sWu5SS+8tnYtn8Us8KaYUERRtqJ8+QL0HQefSOJTn/Dx46zvLCJ+SNOpcmYXznXaEtM5CdlNID9dUsyQ8oA5WhSLXbmP6hdbrC6DdaPFdTWtraVY21nKen54yfbC4sK64pNhzlMeXt6z48UKxb9ls/YqP81uwzL4dL/mXI/pWz/AlxGjzjdsOtkK8Y7ZJwk7bKboFjsAK4fDJ6OZIlJsGSm8ibBr74KUylcMdDhUoKeIkhlbmfnojcPxwmbEmRm746NByLKbQchyno8hz47+vv1AZ79o/PD2Q2ih8MdXhfFgAOD2Ha+jANHBjDQwI9JyN7UspWZkYhbtyNiR7Yg5UeDEyBs7B4ohAYWzxSbBcYjWeI8hCmxCGS2EZSc9tlvZuR8J4/bzJpYaBJXv3ENskxIwji68DMJD3+JOGi5uB8JD+e3KhMc7TL8Ku3EZ44i8D++I2OCv9vZ+1pnZmctXZdSwQsnvocfaLxndMzbm9mDbk8sZnJ7dNvKBvjOXFAyDDxtj/ysOfNQpZF1Z6CghO9bFR5ZbAlqOQwmsZy9497WdrQsUht0QFbk16xwVtgSKTP5uooAgj3+Ig0ECn4IEto8vgR1tEph9GlRwK4KxT1sFjwcVrG1xj62CJ6rFFTL4W2o/vn2+GXTwwEgnpYMnk0EH96+Dq0FxfB0sO0dR7DO6oE+D+j0F9asSv65K/Nq6EgVTpfhNMKVsgyZDGLctM7gHC1jVumsjhol63bfsYF3d4wVla2iOA7HSmYpZ7qblDPHQkdmoBodjNgSHtpyQnD0c3JuuVnfScHV1uTeGnPHLhOInsfcvAfnLrg1+xIsNxZc5W3x9ijDwPfhX4FUIr86WKnThx20oGSxd7OCq2GEfFpJ4mF/MzYurkRIu5eg6aJgBdT0aKMNoikFdqtWQ09Dcxx2cmmM4NbA6UhXSt9Tw6KA8Uo0POZUtVaYUImlRWlFcGsznREPXv4ETixUKl7yAGojlCPmScJ6nwCyK6DMX0+3pKdv+h3hXSvxpC8YZcv5xENCdLa/bcHm1KWg5YZgpl8/MBF3ucYysbVAQVHfwyEPIUwzVvRYx5rU4lX0wW0US13bLMuLVfWK8ZtRQ1kdUF1/zP8VolBnTsJC3UHIqu2CesWeaJHkef8KRv0R44aNA0x9gQiNAC1yWdenGKJROHA695Nanq0uBvmZZo8HCdEtBUzmwr6QgfUULrqyAdxRTwSulZFLFIKW0UcoVgwf2TA+sVuI0ROBUmwsmp8kzF2zk80wjJ0LMPJ7BIzuCR2ZsPfQKl8xQVlnZ2jSxnKDOrOk/Gz/GXm3GYXjEoDvjNj7UfVJiRVuE0VDV9A7uU0fL6zRcXm3uk5x63LlPvEplzg1HjQOUdlFURWWnExSyyf+F0x4g2jPwRdeAUkgRJaC0VWO6qnBLAQcFMA12Qw8ODKMhELRVNZhyauqBxD+zmv9BiB4/NaCqdxorEaIrM2DK6W9lwVMx0B8/RWw/pub8ar47KPbisa91xHep4vn799fK5r2CmyFS04qU9t730rTSSoU4V5dxyrXrIGZ1LK8xarq+upa37KHZW2F46stplphuOysF6ywjqGsGAEXEjY+P48sdwcxlXoHxeg8viIe3fzWtD7/OayeUFMi+5LZAqLzLnyReo6C2Q670B33eyx5R6DLlHjG0VRS6crBQxr60UWq2gqJAaN/OqrfBmYKro6h0nbFVvPdGiTRthUGm7Ar6YbShQzz6pOLRY0U4WslI2sLRpvqp371wdDoTQ0S6Hwt28PO+Srhoi0ibKvs1iPiOllcVke5Vw5c9O/mem46FjnD0wBDdQkgVg1ZBSFsMelL2HpohBq1RjtY8f6sKSKvDjbqYRUZF4H+Pceyj5HVWeMPmZ7Ogm1jxSsYV4k84XPP3Kqf6EwrUgnVI+YYtV255bHG8fYGyYWcNe3ZA4GZF17k+lZQh/6dTGTpOURkailfrWspXZ2pzVk05QbkXAIarVDV5umW1kxfQ5zpppNDVRp80mCuwvbnDa/LDP6lpc8FT2CcwbYY0Qdhb4nyzMyZdkSUJUfD7rpXx8yb0uKuSsvOuzw3JCIE1/sCUPgl3E20oKW52/OjTv/nljLWzo//snbnOfcz04EkcZN+Tf7kWS8JukGziBW6w+ZifzF/ZVddRXuQYB2yj3he/XvcLJkf10zhDclJAZ/zwxilCXeV59wt1OWCulEJHJojTmzc5shWllvxeVg5Hxdy4SK6WSpr3O3NyqCfmMvSUZk1GnPI3BvqdNznokQQYRyc1cRButnX0aZPl47dE3qM49K74b6hw8x6l/hZrEabaYHc881CySq27UbTaRbNfLxM6tNhVL8evN9glzprKOWtsxMVwn0ia8tmhAgg8mN3PbkpctVtvaSDLqBkou2tpILay6Gmvm3Cdy7/w9tcB8t0vjndAzIbcwXI7g+2RastifUBqRZZLB1IBfZnTtkiFPg0cqCOkbn2l3F8XxZd6gSoXbQ1ALX9Ngw6cTgA/jdri1KoZqCOculCGun0QquwVDjiteJhNB1BdsO5GW6DC3/yCA2ki1LGIgOgFquyED0DdBif6ASpUfDCe3RSoNgDQZGK8sdi/seU6o6lhgFKbrhSrAx8xNEaVX1O6IL/h0gvc0TMvMF2nh60kx2WGrbSNHvSylSCFWrAOpDHnQ9EAB+ps88BfQbDqNo/0swl9QFsOnA3Q3gYU+4E2JE1YENcY2lDAw4G6gjYkYftQ1gYXaIK2HNt8KdCu+j3Ik4I2oDQLRmQbQxtKfjhQV9Cegm88sftAqlycNiC1X6luwpgFfHFcY6RCzQ8H6gypgO0nTg0JwwvynynQC225OmqAdsVz1jqgXfbL5s/1QqWBOsuUwN/Q7SNT4rzcAHTl+3VrodpjpgQgVUrgNiZhGCVoKBc6w9LLjb1VPpJ1ShYdkggDxZvR3j+jHbRM96BhO7P2MCdn9UGJLzfuVfVTSieFYqBLmRHuBMXTg4btCMVTmAmvjRtAg9BH3MB5uSGx5wmBIxb3tPbGYHFPQ2+sMyydWQyqMZb6pFDIOm39H6n+Rpf/MwXwB/ni+gty/auXJ88satUc2/0FWGHNTvsqSKgzdFVBuvlv726f6uwDqmcWhcpf3HxSNAwdp9ZlkFAUaiqDlLJWTl35g1TNUBeSdWHU2eljM7zc4vXKN0a2ftysj8qg1rWWJZa/680Ac8t2DbKdyv56gJ2vzQDsI2Z8IQW2rs2EdTqaajMhsOtCElIM48D+1rSHqp7xmeUymu+EHjPKJbWQzy/rgQNp2gl19WqwVKKPiPTYHIB97CfvpKKe1qWYsKhHVymmlAoa9wHVc8sBnmLpA/SvWpdWQr2uq7RSgmofpQ+TM5MLTfN8PZIqTFTYbdWCDR2vhmqhMyydmYVuWvnQI+vBPIXd1kDbbs1AXbHeCKDfqfOqai7QRJNnZtFPsKgHpinstgbdntYM1FkQGb4WuTaIDP3Gcd0FMATYh7qdnFlpUOO90F+oDeZB7LbVkg58OkfXwxWwnGf8PNZmhzEhdL97jKLVR+Jh3uP/ \ No newline at end of file