Skip to content

Commit

Permalink
fix: update readme
Browse files Browse the repository at this point in the history
Signed-off-by: Markus Maga <markus@maga.se>
  • Loading branch information
Flydiverny committed Dec 12, 2024
1 parent c0d6f30 commit 845cd8a
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
This is a GitHub Action for setting up git-crypt in a GitHub Actions workflow. Git-crypt is a tool for encrypting and decrypting files in a Git repository.
The action will download the source for the git-crypt CLI and build it in runtime, it may also be cached in the tools cache.

v4: works on ubuntu 22+
v3: works on ubuntu 20 and 22

## Pre-requisite for self-hosted runners

This action requires openssl and openssl-devel to be installed on your runner (exists by default on github hosted runners).
Expand All @@ -23,7 +26,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: Flydiverny/setup-git-crypt@v3
- uses: flydiverny/setup-git-crypt@v4
```
In this example, the `setup-git-crypt` action is added as a step in the `build` job, and it will be run when the workflow is triggered. The `setup-git-crypt` action will install and configure git-crypt in the environment where the action is running, allowing you to use git-crypt in the rest of your workflow.
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "setup-git-crypt",
"version": "0.1.0",
"version": "4.0.0",
"private": true,
"description": "TypeScript template action",
"main": "lib/main.js",
Expand Down

0 comments on commit 845cd8a

Please sign in to comment.