actions/update-flake-lock
1
0
Fork 0
mirror of https://github.com/DeterminateSystems/update-flake-lock.git synced 2024-12-23 13:32:07 +01:00
Code Issues Projects Releases Packages Wiki Activity

README: organize "Running GitHub Actions CI" instructions into own section

Browse source
This commit is contained in:
Cole Helbling 2022-01-26 08:35:46 -08:00
parent 0c7c875acc
commit bf4213a00e
1 changed files with 20 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

42
README.md
View file

@ -27,7 +27,7 @@ jobs:
extra_nix_config: | extra_nix_config: |
access-tokens = github.com=${{ secrets.GITHUB_TOKEN }} access-tokens = github.com=${{ secrets.GITHUB_TOKEN }}
- name: Update flake.lock - name: Update flake.lock
uses: DeterminateSystems/update-flake-lock@v3 uses: DeterminateSystems/update-flake-lock@vX
``` ```
## Example updating specific input(s) ## Example updating specific input(s)
@ -60,16 +60,26 @@ jobs:
inputs: input1 input2 input3 inputs: input1 input2 input3
``` ```
## Example github action tests in created PRs ## Running GitHub Actions CI
By default, this action uses an api token provided by github ci to create the GitHub Actions will not run workflows when a branch is pushed by or a PR is opened by a GitHub Action. There are two ways to have GitHub Actions CI run on a PR submitted by this action.
pull request. By default, Github does not run github actions, i.e. tests, for
these types of pull requests. However, you can bypass this restriction by ### Without a Personal Authentication Token
specifying a personal authentication token (PAT). You can create a token by
visiting [https://github.com/settings/tokens]() and select at least the scope Without using a Personal Authentication Token, you can manually run the following to kick off a CI run:
`repo`. Then store this token in your repository secrets (i.e.
'https://github.com/<USER>/<REPO>/settings/secrets/actions') as ```
`GH_TOKEN_FOR_UPDATES`. git branch -D update_flake_lock_action
git fetch origin
git checkout update_flake_lock_action
git commit --amend --no-edit
git push origin update_flake_lock_action --force
```
### With a Personal Authentication Token
By providing a Personal Authentication Token, the PR will be submitted in a way that bypasses this limitation (GitHub will essentially think it is the owner of the PAT submitting the PR, and not an Action).
You can create a token by visiting https://github.com/settings/tokens and select at least the `repo` scope. Then, store this token in your repository secrets (i.e. 'https://github.com/<USER>/<REPO>/settings/secrets/actions') as `GH_TOKEN_FOR_UPDATES` and set up your workflow file like the following:
```yaml ```yaml
name: update-flake-lock name: update-flake-lock
@ -92,18 +102,6 @@ jobs:
token: ${{ secrets.GH_TOKEN_FOR_UPDATES }} token: ${{ secrets.GH_TOKEN_FOR_UPDATES }}
``` ```
## Running GitHub Actions CI
GitHub Actions will not run workflows when a branch is pushed by or a PR is opened by a GitHub Action. To work around this, try:
```
git branch -D update_flake_lock_action
git fetch origin
git checkout update_flake_lock_action
git commit --amend --no-edit
git push origin update_flake_lock_action --force
```
## Contributing ## Contributing
Feel free to send a PR or open an issue if you find something functions unexpectedly! Please make sure to test your changes and update any related documentation before submitting your PR. Feel free to send a PR or open an issue if you find something functions unexpectedly! Please make sure to test your changes and update any related documentation before submitting your PR.