Skip to content

Commit

Permalink
chore: add initial doc for jfrog-login (#24)
Browse files Browse the repository at this point in the history
* chore: remove old action and better readme for login

* chore: add basic doc
  • Loading branch information
AEnguerrand authored Sep 10, 2024
1 parent 16e7118 commit 019632e
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 120 deletions.
29 changes: 27 additions & 2 deletions actions/jfrog-login/README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,20 @@
# Action: jfrog-login

<!-- action-docs-description source="action.yml" -->
## Description

This action is used to login to the JFrog Plateform of Ledger (Artifactory, Xray, etc.).
<!-- action-docs-description source="action.yml" -->

## Usage

### Permissions
```yaml
permissions:
id-token: write
```
### Example Workflow
```yaml
jobs:
release:
Expand All @@ -18,4 +23,24 @@ jobs:
- name: Login to JFrog Ledger
id: jfrog-login
uses: LedgerHQ/actions-security/actions/jfrog-login@actions/jfrog-login-1
```
```
## Inputs
This actions require no inputs.
<!-- action-docs-outputs source="action.yml" -->
## Outputs
| name | description |
| --- | --- |
| `oidc-token` | <p>From JFrog CLI: JFrog OIDC token generated by the Setup JFrog CLI when setting oidc-provider-name.</p> |
| `oidc-user` | <p>From JFrog CLI: JFrog OIDC username from the OIDC token generated by the Setup JFrog CLI when setting oidc-provider-name.</p> |
| `jfrog-url` | <p>Jfrog URL to be used for the JFrog API / CLI</p> |
<!-- action-docs-outputs source="action.yml" -->


<!-- action-docs-runs source="action.yml" -->
## Runs

This action is a `composite` action.
<!-- action-docs-runs source="action.yml" -->
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
name: "[Ledger Security] Login to JFrog"
description: "Ledger Security Action wrapper to login to JFrog"
author: LedgerHQ
description: "This action is used to login to the JFrog Plateform of Ledger (Artifactory, Xray, etc.)."

outputs:
oidc-token:
Expand Down
92 changes: 0 additions & 92 deletions actions/jfrog-upload/CHANGELOG.md

This file was deleted.

25 changes: 0 additions & 25 deletions actions/jfrog-upload/action.yaml

This file was deleted.

0 comments on commit 019632e

Please sign in to comment.