Skip to content

Commit

Permalink
root: updated for v1.3.0 release
Browse files Browse the repository at this point in the history
Since I need to release the current base native CI version of
template for my next project, I should update all the documents
to match it. Hence, let's do this.

This patch updates all documents in root directory for v1.3.0
release.

Signed-off-by: (Holloway) Chew, Kean Ho <[email protected]>
  • Loading branch information
hollowaykeanho committed Aug 14, 2023
1 parent daf0484 commit 5db9c0b
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 19 deletions.
13 changes: 2 additions & 11 deletions .github/workflows/push.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
name: GitHub CI on Push
run-name: Run the repo development process across all OSes for main & staging/next branches.
run-name: Run the repo development process across all OSes for main & next/staging/testing branches.
on:
push:
branches: [ main, staging, next ]
branches: [ main, staging, next, testing ]
jobs:
run-on-linux-deb:
runs-on: ubuntu-latest
Expand All @@ -13,10 +13,7 @@ jobs:
- run: . ./ci.cmd prepare
- run: . ./ci.cmd test
- run: . ./ci.cmd build
- run: . ./ci.cmd package
- run: . ./ci.cmd release
- run: . ./ci.cmd compose
- run: . ./ci.cmd publish
run-on-windows:
runs-on: windows-latest
steps:
Expand All @@ -26,10 +23,7 @@ jobs:
- run: .\ci.cmd prepare
- run: .\ci.cmd test
- run: .\ci.cmd build
- run: .\ci.cmd package
- run: .\ci.cmd release
- run: .\ci.cmd compose
- run: .\ci.cmd publish
run-on-macos:
runs-on: macos-latest
steps:
Expand All @@ -39,7 +33,4 @@ jobs:
- run: . ./ci.cmd prepare
- run: . ./ci.cmd test
- run: . ./ci.cmd build
- run: . ./ci.cmd package
- run: . ./ci.cmd release
- run: . ./ci.cmd compose
- run: . ./ci.cmd publish
12 changes: 6 additions & 6 deletions CONFIG.toml
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ PROJECT_VERSION = "0.0.1"


# PROJECT STRUCTURE
PROJECT_PATH_TOOLS = "tools" # relative to root
PROJECT_PATH_BUILD = "build" # relative to root
PROJECT_PATH_TEMP = "tmp" # relative to root
PROJECT_PATH_SOURCE = "src" # relative to root
PROJECT_PATH_CI = "ci" # relative to root
PROJECT_PATH_PKG = "pkg" # relative to root
PROJECT_PATH_TOOLS = "tools" # relative to repository root
PROJECT_PATH_BUILD = "build" # relative to repository root
PROJECT_PATH_TEMP = "tmp" # relative to repository root
PROJECT_PATH_SOURCE = "src" # relative to repository root
PROJECT_PATH_CI = "ci" # relative to repository root
PROJECT_PATH_PKG = "pkg" # relative to repository root
37 changes: 35 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,10 @@ repository.
> all the output logos OR delete them entirely.
> 2. Update this `README.md` especially dealing with title + anything below for
> marking and business objectives (like WHY then HOW).
> 3. Add a `LICENSE.md` file with the appropriate license(s).
> 3. Select A `LICENSE.pdf` file with the appropriate license(s).
> 4. Add a `CODE_OF_CONDUCT.md` file with the appropriate legal clauses(s).
> 5. Update the `automata/*.cmd` CI executions matching the project.
> 5. Update the `CONFIG.toml` matching the project metadata.
> 5. Update the `automata/*` CI executions instructions matching the project.
> 6. Delete this blockquote once everything is completed.

Expand Down Expand Up @@ -44,6 +45,7 @@ maintainers.
### Directory Structure
```
automata/ 🠚 house the projects' CI automation scripts.
automata/services 🠚 house tested and pre-built CI automation functions.
bin/ 🠚 default build output directory.
pkg/ 🠚 default package output directory.
resources/ 🠚 housing all indirect raw materials and assets.
Expand All @@ -60,6 +62,18 @@ SECURITY.md 🠚 repository's security instruction file.



### Branch Management
The default uses the following branch managements:

```
main = for customers who use git (house stable releases)
next || staging || testing = [OPTIONAL] for test developers to test the next release
edge || experimental = for project maintainer to develop new feature.
```




### Native Continuous Integration (Native CI) Infrastructure
This repository is governed by a native CI scripted using
[Polygot Script](https://github.com/ChewKeanHo/PolygotScript) called `ci.cmd`.
Expand Down Expand Up @@ -187,6 +201,25 @@ $ ./ci.cmd publish



### GitHub Actions
By default, the GitHub action only executes in this sequence:

1. `setup`
2. `start`
3. `prepare`
4. `test`
5. `build`
6. `compose`

for `git push` against `main`, `next`, `staging`, or `testing` branches.

For `package`, `release`, and `publish` CI jobs, due to the invovlement of
private identitiy signing keys, they are best to be implemented at the local
side (to protect the key from any unnecessary leak due to 3rd-party).




## License
This project is licensed under multiple licenses such that:

Expand Down

0 comments on commit 5db9c0b

Please sign in to comment.