Skip to content

Commit

Permalink
push again
Browse files Browse the repository at this point in the history
  • Loading branch information
bossOfCode authored Sep 2, 2024
1 parent 27d99e7 commit 442ce7c
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,27 @@
# Generate UUID

Generates a random UUID using the `uuid` module in python.

[![test](https://github.com/bossOfCode/generate-uuid/actions/workflows/manual.yml/badge.svg)](https://github.com/bossOfCode/generate-uuid/actions/workflows/manual.yml) [![test2](https://github.com/bossOfCode/generate-uuid/actions/workflows/manual2.yml/badge.svg)](https://github.com/bossOfCode/generate-uuid/actions/workflows/manual2.yml)

## Inputs

* `version` - REQIURED - Version of UUID to generate. Versions are 1, 3, 4, and 5.

> Note: Version 1 may pose a safety risk because it uses your network info.
* `namespace` - optional - namespace of the UUID. Can be DNS, URL, OID, or X500.

* `name` - optional - string that will be used to create the UUID.

## Outputs

* `uuid` - The generated UUID
* `safe` - The safeness of the UUID. `safe` means the UUID was generated by the platform in a multiprocessing-safe way, `unsafe` means the UUID was not generated in a multiprocessing-safe way, and `unknown` means the platform did not provide information on whether the UUID was generated safely or not.
<sup>Source: [[1]](https://docs.python.org/3/library/uuid.html#uuid.SafeUUID)</sup>

## Usage

```yaml
- uses: actions/[email protected]
- uses: actions/[email protected]
Expand All @@ -24,5 +31,3 @@ Generates a random UUID using the `uuid` module in python.
with:
- version: 5 #v1, 3, 4, snd 5 are avaliable
```
<br><br>
<footer> [1]: docs.python.org </footer>

0 comments on commit 442ce7c

Please sign in to comment.