Skip to content

Commit

Permalink
docs: document ephemerality expectations
Browse files Browse the repository at this point in the history
  • Loading branch information
@joemiller
joemiller committed Apr 5, 2023
1 parent 82735c6 commit 97bb6fc
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,9 @@ ghcommit -r owner/repo -b branch --add newfile.txt --add changedfile.txt --delet

All flags may be provided via environment variables. Run `ghcommit -h` to see the full list of flags and env vars.

> NOTE: Changes are not reflected on the local clone of the repository. The commit is made directly to the GitHub repository.
> This utility is meant to be run from CI pipelines where the local clone is ephemeral.
## Alternatives

As mentioned above, it is possible to sign commits with GPG.
Expand Down

0 comments on commit 97bb6fc

Please sign in to comment.