Skip to content

Commit

Permalink
Update 3. SIMPLIFIED EXPLANATION OF HOW IT WORKS.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ztrhgf authored Apr 7, 2021
1 parent fe6d593 commit 8dd3a7d
Showing 1 changed file with 31 additions and 1 deletion.
32 changes: 31 additions & 1 deletion 3. SIMPLIFIED EXPLANATION OF HOW IT WORKS.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Explanation of repository content, it's purpose and automation behind it


### Important content of repository and it's purpose
### Important content of the repository and it's purpose

```
<<your cloned repository root>>
Expand Down Expand Up @@ -54,5 +54,35 @@
└───profile.ps1 -- PowerShell profile, that will be copied to C:\Windows\System32\WindowsPowerShell\v1.0 (i.e. will be global PowerShell profile) on computers in variable $_computerWithProfile (defined in Variables module)
-- contains many usefull features such as customized consoel title, that shows number of commits, this console is behind your computer state etc
```
# How code validation works
- after you commit your changes, pre-commit git hook automatically initiate checks defined in pre-commit.ps1
- only if all checks are passed, commit will be created and content distributed
- checks can stop creation of commit completely, or warn you about possible problems and let you decide, whether to continue

## What is validated before commit is created
- that you are not trying to delete important repository files
- that Powershell files
- are encoded as UTF-8 or UTF-8 with BOM
- have valid syntax
- doesn't contain EN DASH, EM DASH instead of dash (it would lead to strange errors)
- doesn't contain #FIXME comment, otherwise warn about it
- from which modules are generated are in correct form
- warn about changed function parameters (in case, the functions is used elsewhere)
- warn about changed function aliases (in case, the alias is used elsewhere)
- warn about deleted function (in case, the function is used elsewhere)
- warn about changed variable value from module Variables (in case, the variable is used elsewhere)
- warn about deleted variable from module Variables (in case, the variable is used elsewhere)
- ...


# How distribution of content works
- after successful commit, content is automatically:
- pushed to GIT repository
- by post-commit GIT hook (post-commit.ps1)
- pulled to local server, processed and (clients part) distributed to shared folder
- by repo_sync.ps1 which is regularly run every 15 minutes by scheduled task
- from shared folder the content is being downloaded by clients in your Active Directory
- by PS_env_set_up.ps1 which is regularly run on client every 30 minutes by automatically created scheduled task (created via GPO PS_env_set_up)


TODO

0 comments on commit 8dd3a7d

Please sign in to comment.