Skip to content

feat(action): add api token auth to readme instead of email/pw #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
NJona wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(action): add api token auth to readme instead of email/pw #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 8 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,33 +4,30 @@ This action creates a preview environment of your repository in Codesphere.

## :warning: Prerequisites

- Configure a user in Codesphere https://codesphere.com with username and password.
- If you don't have an account on Codesphere yet, create one at https://cloud.codesphere.com or your private cloud url
- Connect your user account with GitHub and allow access to your repository.
- Create an api token at https://cloud.codesphere.com/ide/user/public-api-keys for authentication (replace cloud.codesphere.com with your private cloud url if you want to use it with your private cloud instance)

## Inputs

### `email`
### `apiToken`

**Required** email of the codesphere user.

### `password`

**Required** Password of the codesphere user account.
**Required** api token of the codesphere user.

### `team`

**Required** Name of the codesphere team.

### `plan`

Plan of the created workspace.
Plan of the workspaces ide service. All landscape services are deployed with the plan configured in your selected ci profile

Available options:
- Micro
- Boost
- Pro

Default `"Boost"`.
Default: Smallest plan

### `onDemand`

Expand Down Expand Up @@ -109,8 +106,7 @@ This integration can either be used as an action or as a workflow.
# .github/workflows/codesphere.yaml
uses: codesphere-cloud/gh-action-deploy@main
with:
email: 'bot@example.com'
password: '123'
apiToken: 'xxx'
team: 'MyTeam'
plan: 'Boost'
env: |
Expand Down Expand Up @@ -153,8 +149,7 @@ jobs:
env:
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
with:
email: ${{ secrets.CS_EMAIL }}
password: ${{ secrets.CS_PASSWORD }}
apiToken: ${{ secrets.CS_API_TOKEN }}
team: 'My Team'
plan: 'Boost'
env: |
Expand Down
9 changes: 3 additions & 6 deletions action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,15 @@ runs:
using: 'node24'
main: 'main.js'
inputs:
email:
description: 'email of the codesphere user'
required: true
password:
description: 'Password of the codesphere user account'
apiToken:
description: 'api token of the user'
required: true
team:
description: 'Name of the codesphere team'
required: true
plan:
description: |
Plan of the created workspace.
Plan of the workspaces ide service. All landscape services are deployed with the plan configured in your selected ci profile

Available options:
- Micro
Expand Down