diff --git a/.github/workflows/lint_pr.yml b/.github/workflows/lint_pr.yml new file mode 100644 index 0000000..cdcac20 --- /dev/null +++ b/.github/workflows/lint_pr.yml @@ -0,0 +1,69 @@ +name: "lint pull request CI" + +on: + #pull_request: + pull_request_target: + types: + - opened + - edited + - synchronize + +jobs: + main: + name: Validate PR title + runs-on: ubuntu-latest + steps: + - uses: amannn/action-semantic-pull-request@v5 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + with: + # Configure which types are allowed (newline delimited). + # Default: https://github.com/commitizen/conventional-commit-types + #types: | + # fix + # feat + # Configure which scopes are allowed (newline delimited). + scopes: | + content + workflow + other + # Configure that a scope must always be provided. + requireScope: true + # Configure which scopes (newline delimited) are disallowed in PR + # titles. For instance by setting # the value below, `chore(release): + # ...` and `ci(e2e,release): ...` will be rejected. + #disallowScopes: | + # release + # Configure additional validation for the subject based on a regex. + # This example ensures the subject doesn't start with an uppercase character. + subjectPattern: ^(?![A-Z]).+$ + # If `subjectPattern` is configured, you can use this property to override + # the default error message that is shown when the pattern doesn't match. + # The variables `subject` and `title` can be used within the message. + subjectPatternError: | + The subject "{subject}" found in the pull request title "{title}" + didn't match the configured pattern. Please ensure that the subject + doesn't start with an uppercase character. + # If you use GitHub Enterprise, you can set this to the URL of your server + #githubBaseUrl: https://github.myorg.com/api/v3 + # If the PR contains one of these labels (newline delimited), the + # validation is skipped. + # If you want to rerun the validation when labels change, you might want + # to use the `labeled` and `unlabeled` event triggers in your workflow. + #ignoreLabels: | + # bot + # ignore-semantic-pull-request + # If you're using a format for the PR title that differs from the traditional Conventional + # Commits spec, you can use these options to customize the parsing of the type, scope and + # subject. The `headerPattern` should contain a regex where the capturing groups in parentheses + # correspond to the parts listed in `headerPatternCorrespondence`. + # See: https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-commits-parser#headerpattern + headerPattern: '^(\w*)(?:\(([\w$.\-*/ ]*)\))?: (.*)$' + headerPatternCorrespondence: type, scope, subject + # For work-in-progress PRs you can typically use draft pull requests + # from GitHub. However, private repositories on the free plan don't have + # this option and therefore this action allows you to opt-in to using the + # special "[WIP]" prefix to indicate this state. This will avoid the + # validation of the PR title and the pull request checks remain pending. + # Note that a second check will be reported if this is enabled. + wip: true diff --git a/README.md b/README.md index 711a13b..6554e3a 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ This package requires: This package uses: - [vuepress](https://github.com/vuejs/vuepress) - [vuepress-theme-book](https://github.com/cyrilf/vuepress-theme-book) - +- [vuepress-deploy](https://github.com/jenkey2011/vuepress-deploy) ## Usage @@ -40,4 +40,12 @@ Run the tests to ensure everything is working as expected ``` npm test -``` \ No newline at end of file +``` + +## How it works + +This repository utilizes `vuepress-deploy` to automatically deploy the current `master` branch to github pages. + +![repo-architecture](./docs/images/docs/architecture.png) + +A Pullrequest-Review-Workflow is applied to get changes into the `master`. From there on an automatic github workflow script utilizing `vuepress-deploy` is taking over. The vuepress page is built and force-pushed to the `gh-pages` branch, which in turn is then deployed on the github pages infrastructure and bound to the web address [IT4C.dev](https://www.it4c.dev). diff --git a/docs/images/docs/architecture.drawio b/docs/images/docs/architecture.drawio new file mode 100644 index 0000000..2f8f71e --- /dev/null +++ b/docs/images/docs/architecture.drawio @@ -0,0 +1,138 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/images/docs/architecture.png b/docs/images/docs/architecture.png new file mode 100644 index 0000000..39a962e Binary files /dev/null and b/docs/images/docs/architecture.png differ diff --git a/docs/people/ulf-gebhardt.md b/docs/people/ulf-gebhardt.md index 5829b4d..eece7ef 100644 --- a/docs/people/ulf-gebhardt.md +++ b/docs/people/ulf-gebhardt.md @@ -2,7 +2,7 @@ ![Ulf Gebhardt](~@images/portrait/ulf-gebhardt.jpg) -Ulf is a software developer through and through. He started to program when he was 12 and kept going with it. He knows about the possibilities soft- and hardware has to offer and is the person to turn to when it’s time to include a new library or implement an algorithm. He is known to use the "Holzhammer-Methode" (brute-force approach) when it comes to solve conflicts within the team. +Ulf is a software developer through and through. He started to program when he was 12 and kept going with it. He knows about the possibilities software and hardware have to offer and is the person to turn to when it’s time to include a new library or implement an algorithm. He is known to use the "Holzhammer-Methode" (brute-force approach) when it comes to solve conflicts within the team. In his free time he programs as every good programmer does and travels the world by foot when it’s time to leave the screen for a while. @@ -68,7 +68,7 @@ here is a quick overview over the computer languages, frameworks and technologie ### Computer languages -Ulf has worked with the following Programming languages: +Ulf has worked with the following programming languages: - [Javascript](https://www.javascript.com/) - [PHP](https://www.php.net/) @@ -87,7 +87,7 @@ Ulf has worked with the following Programming languages: ### Frameworks & Technologies -As IT grows more complex it’s important with which frameworks is familiar. The following represents an incomplete list of Ulf’s framework and technology knowledge: +As IT grows more complex it’s important which frameworks one is familiar with. The following represents an incomplete list of Ulf’s framework and technology knowledge: #### For Javascript: - [Node](https://github.com/nodejs/node) @@ -144,6 +144,6 @@ As IT grows more complex it’s important with which frameworks is familiar. The - [Gitlab](https://about.gitlab.com/) - [Gogs](https://gogs.io/) - [Github Workflows](https://docs.github.com/en/rest/actions/workflows) -- [Kanaban](https://en.wikipedia.org/wiki/Kanban) +- [Kanban](https://en.wikipedia.org/wiki/Kanban) - [Zenhub](https://www.zenhub.com/) - [Agile software development](https://en.wikipedia.org/wiki/Agile_software_development)