Skip to content

Commit

Permalink
docs: 📝 document realease notes v2
Browse files Browse the repository at this point in the history
Signed-off-by: Andy Augustin <dev@andreas-augustin.org>
  • Loading branch information
AndreasAugustin committed Mar 13, 2024
1 parent 979090e commit da706d8
Show file tree
Hide file tree
Showing 2 changed files with 17 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
uses: AndreasAugustin/actions-template-sync@v2
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
source_repo_path: AndreasAugustin/template
Expand Down
25 changes: 16 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ jobs:
# submodules: true

- name: actions-template-sync
uses: AndreasAugustin/actions-template-sync@v1
uses: AndreasAugustin/actions-template-sync@v2
with:
source_repo_path: <owner/repo>
upstream_branch: <target_branch> # defaults to main
Expand Down Expand Up @@ -133,7 +133,7 @@ jobs:
token: ${{ steps.generate_token.outputs.token }}

- name: actions-template-sync
uses: AndreasAugustin/actions-template-sync@v1
uses: AndreasAugustin/actions-template-sync@v2
with:
github_token: ${{ steps.generate_token.outputs.token }}
source_repo_path: <owner/repo>
Expand Down Expand Up @@ -169,7 +169,7 @@ jobs:
token: ${{ secrets.GITHUB_TOKEN }}
- name: actions-template-sync
uses: AndreasAugustin/actions-template-sync@v1
uses: AndreasAugustin/actions-template-sync@v2
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
source_repo_path: ${{ secrets.SOURCE_REPO_PATH }} # <owner/repo>, should be within secrets
Expand Down Expand Up @@ -223,7 +223,7 @@ jobs:
token: ${{ secrets.CUSTOM_GITHUB_PAT }}
- name: Test action step PAT
uses: AndreasAugustin/actions-template-sync@v1
uses: AndreasAugustin/actions-template-sync@v2
with:
github_token: ${{ secrets.CUSTOM_GITHUB_PAT }}
source_repo_path: ${{ secrets.SOURCE_REPO_PATH }} # <owner/repo>, should be within secrets
Expand Down Expand Up @@ -372,7 +372,7 @@ jobs:
uses: actions/checkout@v4
- name: actions-template-sync
uses: AndreasAugustin/actions-template-sync@v1
uses: AndreasAugustin/actions-template-sync@v2
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
source_repo_path: <owner/repo>
Expand Down Expand Up @@ -408,7 +408,7 @@ E.q. for the installation phase you need to use commands like `apk add --update

```yml
- name: Test action step
uses: AndreasAugustin/actions-template-sync@v1
uses: AndreasAugustin/actions-template-sync@v2
env:
MY_VAR: "foo" # possible to define envrionment variables
with:
Expand All @@ -429,7 +429,7 @@ E.q. for the installation phase you need to use commands like `apk add --update

```yml
- name: Test action step
uses: AndreasAugustin/actions-template-sync@v1
uses: AndreasAugustin/actions-template-sync@v2
with:
source_repo_path: AndreasAugustin/template.git
upstream_branch: main
Expand Down Expand Up @@ -528,7 +528,7 @@ You need to change the default one e.g. to `git_remote_pull_params: --allow-unre
token: ${{ secrets.<secret_name> }}
- name: actions-template-sync
uses: AndreasAugustin/actions-template-sync@v1
uses: AndreasAugustin/actions-template-sync@v2
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
source_repo_path: <owner/repo>
Expand All @@ -541,8 +541,13 @@ You need to change the default one e.g. to `git_remote_pull_params: --allow-unre
Open your project `Settings > Actions > General` and select the checkbox `Allow GitHub Actions to create and approve pull requests`
under the `Workflow permissions` section.

## Release Updates
## Release update notes

* `v2`
* `git lfs` is no default anymore. Enable with `is_git_lfs` parameter.
* infrastructure change: now using [composite action][action-composite] instead of [docker action][action-docker]
to be more flexible to combine more actions (file system permissions).
* local `git config` now instead of global `git config --global` in respect to be more flexible in chaining actions.
* :warning: starting with version `v1` (`v1.0.0`) the `upstream_branch` variable default is not `main` anymore. It is now set to the remote default branch.
* starting with version v0.5.2-draft the `templateversionrc` file is not needed anymore. You can delete that file from the target repositories.

Expand Down Expand Up @@ -638,6 +643,8 @@ specification. Contributions of any kind are welcome!
[enabling-debug-logging]: https://docs.github.com/en/actions/managing-workflow-runs/enabling-debug-logging
[deployment-keys]: https://docs.github.com/en/developers/overview/managing-deploy-keys#deploy-keys
[action-triggers]: https://docs.github.com/en/actions/reference/events-that-trigger-workflows
[action-composite]: https://docs.github.com/en/actions/creating-actions/creating-a-composite-action
[action-docker]: https://docs.github.com/en/actions/creating-actions/creating-a-docker-container-action
[template]: https://github.com/AndreasAugustin/template
[marketplace]: https://github.com/marketplace/actions/actions-template-sync
[self-usage]: https://github.com/AndreasAugustin/actions-template-sync/blob/main/.github/workflows/actions_template_sync.yml
Expand Down

0 comments on commit da706d8

Please sign in to comment.