Skip to content

Commit

Permalink
root: updated documentations for releases
Browse files Browse the repository at this point in the history
Since the repository is now ready, we should update it for release.
Hence, let's do this.

This patch updates documentations for releases in root repository.

Co-authored-by: Galyna, Cory <[email protected]>
Co-authored-by: (Holloway) Chew, Kean Ho <[email protected]>
Signed-off-by: (Holloway) Chew, Kean Ho <[email protected]>
  • Loading branch information
hollowaykeanho and corygalyna committed Sep 18, 2023
1 parent c7340fa commit c59d92e
Show file tree
Hide file tree
Showing 4 changed files with 35 additions and 3 deletions.
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ representative at an online or offline event.

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement by raising a
matter forum in the discussion section. All complaints will be reviewed and
matter forum in the Issues section. All complaints will be reviewed and
investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
Expand Down
36 changes: 34 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ supply chain threat at least in the 2021-2023 era.

Some good business reasons why AutomataCI is made:

1. **Start off with a tested and solid foundation** - all the templates and
1. **Start off with a tested and solid foundation** - All the templates and
CI jobs are tested and have default configured for immediate software
development.
2. **Avoid being threatend by your CI provider** - CI it's a life-support system
Expand Down Expand Up @@ -157,18 +157,50 @@ decided your tech, you may remove all the unused source directories
### Git Commit Initial Setup

At this point, your repo is now ready. Feel free to git commit your
initialization:
initialization (assuming you're using `main` as primary branch):

```
$ git add .
$ git commit -s
... WRITE YOUR COMMIT ...
$ git push -u origin main:main
$ git switch --orphan gh-pages
$ git commit --allow-empty -m "Initial Commit"
$ git push origin gh-pages:gh-pages
$ git checkout main
```




## Operating AutomataCI

To operate AutomataCI, simply execute the `ci.cmd` help section:

```
$ ./ci.cmd help
Please try any of the following:
To seek commands' help 🠚 $ ./ci.cmd help
To initialize environment 🠚 $ ./ci.cmd env
To setup the repo for work 🠚 $ ./ci.cmd setup
To start a development 🠚 $ ./ci.cmd start
To test the repo 🠚 $ ./ci.cmd test
To prepare the repo 🠚 $ ./ci.cmd prepare
To build the repo 🠚 $ ./ci.cmd build
To package the repo product 🠚 $ ./ci.cmd package
To release the repo product 🠚 $ ./ci.cmd release
To stop a development 🠚 $ ./ci.cmd stop
To clean the workspace 🠚 $ ./ci.cmd clean
To purge everything 🠚 $ ./ci.cmd purge
```

The CI jobs are arranged in a storyline manner from top to bottom. Feel free
to execute accordingly.




## To Contribute

AutomataCI cannot be made successfully without contributions from (Holloway)
Expand Down
Binary file modified automataCI/AutomataCI-Engineering-Specification.odt
Binary file not shown.
Binary file modified automataCI/AutomataCI-Engineering-Specification.pdf
Binary file not shown.

0 comments on commit c59d92e

Please sign in to comment.