-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
27d99e7
commit 442ce7c
Showing
1 changed file
with
7 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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] | ||
|
@@ -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> |