Skip to content

Commit

Permalink
docs(#428): 📝 (#428) update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
AndreasAugustin committed Dec 31, 2023
1 parent 92db951 commit 7bf5d11
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 10 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/actions_template_sync.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ jobs:
- name: Checkout
uses: actions/checkout@v4
- name: actions-template-sync
uses: AndreasAugustin/actions-template-sync@v1.1.8
uses: AndreasAugustin/actions-template-sync@v1.1.9
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
source_repo_path: AndreasAugustin/template
Expand Down
23 changes: 14 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ jobs:
token: ${{ secrets.GITHUB_TOKEN }}

- name: actions-template-sync
uses: AndreasAugustin/actions-template-sync@v1.1.8
uses: AndreasAugustin/actions-template-sync@v1.1.9
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
source_repo_path: <owner/repo>
Expand Down Expand Up @@ -131,7 +131,7 @@ jobs:
token: ${{ steps.generate_token.outputs.token }}

- name: actions-template-sync
uses: AndreasAugustin/actions-template-sync@v1.1.8
uses: AndreasAugustin/actions-template-sync@v1.1.9
with:
github_token: ${{ steps.generate_token.outputs.token }}
source_repo_path: <owner/repo>
Expand Down Expand Up @@ -166,7 +166,7 @@ jobs:
token: ${{ secrets.GITHUB_TOKEN }}
- name: actions-template-sync
uses: AndreasAugustin/actions-template-sync@v1.1.8
uses: AndreasAugustin/actions-template-sync@v1.1.9
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
source_repo_path: ${{ secrets.SOURCE_REPO_PATH }} # <owner/repo>, should be within secrets
Expand Down Expand Up @@ -219,7 +219,7 @@ jobs:
token: ${{ secrets.CUSTOM_GITHUB_PAT }}
- name: Test action step PAT
uses: AndreasAugustin/actions-template-sync@v1.1.8
uses: AndreasAugustin/actions-template-sync@v1.1.9
with:
github_token: ${{ secrets.CUSTOM_GITHUB_PAT }}
source_repo_path: ${{ secrets.SOURCE_REPO_PATH }} # <owner/repo>, should be within secrets
Expand Down Expand Up @@ -255,7 +255,11 @@ There are docker images available. Please checkout [How to use docker](docs/DOCK
This repo uses this [template][template] and this action from the [marketplace][marketplace].
See the definition [here][self-usage].

If you look for a more detailed guide you can have a look at [Dev.to][devto-example] or [GitHub][github-example]
If you look for a more detailed guide you can have a look at

* [Dev.to][devto-example]
* [GitHub][github-example]
* :heart: [nice blog post][dotdc-blog]

### Trigger

Expand Down Expand Up @@ -299,7 +303,7 @@ The following hooks are supported (please check [docs/ARCHITECTURE.md](docs/ARCH
**Remark** The underlying OS is defined by an Alpine container.
E.q. for the installation phase you need to use commands like `apk add --update --no-cache python3`

Schema and example for the `temlatesync.yml`
Schema and example for the `templatesync.yml`

```yml
hooks:
Expand Down Expand Up @@ -348,7 +352,7 @@ For more information, see "[Enabling debug logging.][enabling-debug-logging]"

There are other great tools available within GitHub. Here you can find a comparison.

| **feature** | **actions-template-sync** |[repo-sync][other-repo-sync]| [git-repo-sync][other-git-repo-sync] | [action-template-repository-sync][other-action-template-repository-sync] |
| **feature** | **actions-template-sync** |[github-sync][other-repo-sync]| [git-repo-sync][other-git-repo-sync] | [action-template-repository-sync][other-action-template-repository-sync] |
| ----------- | ------------------------- | -------------------------- | ------------------------------------ | --------------------------------- |
| GitHub action | :heavy_check_mark: | :heavy_check_mark: | :x: | :heavy_check_mark: |
| hooks | :heavy_check_mark: | :x: | :x: | :x: |
Expand Down Expand Up @@ -438,7 +442,8 @@ specification. Contributions of any kind are welcome!
[dockerhub-repo]: https://hub.docker.com/r/andyaugustin/actions-template-sync
[github-repo]: https://github.com/AndreasAugustin/actions-template-sync/pkgs/container/actions-template-sync
[github-pat]: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token
[other-repo-sync]: https://github.com/repo-sync/repo-sync
[other-repo-sync]: https://github.com/repo-sync/github-sync
[other-git-repo-sync]: https://github.com/it3xl/git-repo-sync
[other-action-template-repository-sync]: https://github.com/it3xl/git-repo-sync
[other-action-template-repository-sync]: https://github.com/ahmadnassri/action-template-repository-sync
[git-glossary]: https://git-scm.com/docs/gitglossary
[dotdc-blog]: https://0xdc.me/blog/github-templates-and-repository-sync/

0 comments on commit 7bf5d11

Please sign in to comment.