Skip to content

Commit

Permalink
Updated readme and docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mishushakov committed Oct 2, 2023
1 parent 3670883 commit 25da927
Show file tree
Hide file tree
Showing 6 changed files with 23 additions and 21 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
![Step CI CLI Demo](https://i.imgur.com/QgC0cRr.gif)

> **Note**
> We just announced [Enterprise Support Tier](#enterprise-support) for Step CI
> We just announced [Enterprise Support Tier](#support) for Step CI
# Welcome

Expand All @@ -16,7 +16,7 @@ Step CI is an open-source API Quality Assurance framework

[**Try the Online Playground**](https://stepci.com)

[**Join us on GitHub Discussions**](https://github.com/stepci/stepci/discussions)
[**Join us on Discord**](https://discord.gg/KqJJzJ3BTu)

## Get started

Expand Down Expand Up @@ -90,9 +90,13 @@ Join our community on [Discord](https://discord.gg/KqJJzJ3BTu) and [GitHub](http
As an open-source project, we welcome contributions from the community. If you are experiencing any bugs or want to add some improvements, please feel free to open an issue or pull request
## License
## Support
The source code is distributed under Mozilla Public License terms
Get support hours covered by SLA, setup and training sessions, prioritized feature requests and bug resolution.
[→ Learn more](https://stepci.com/#pricing)
[→ Schedule a call](https://cal.com/wissmueller/30-minute-call)
## Privacy
Expand All @@ -107,10 +111,6 @@ By default, the CLI collects anonymous usage data, which includes:
> **Note**: The usage analytics can be disabled by setting `STEPCI_DISABLE_ANALYTICS` environment variable
## Support
Get support hours covered by SLA, setup and training sessions, prioritized feature requests and bug resolution.
[→ Learn more](https://stepci.com/#pricing)
## License
[→ Schedule a call](https://cal.com/wissmueller/30-minute-call)
The source code is distributed under Mozilla Public License terms
2 changes: 2 additions & 0 deletions docs/.vitepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,8 @@ export default {
text: 'Import',
items: [
{ text: 'OpenAPI', link: '/import/openapi' },
{ text: 'Postman', link: 'https://github.com/stepci/stepci/issues/29' },
{ text: 'Insomnia', link: 'https://github.com/stepci/stepci/issues/30' },
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,6 @@ Get support hours covered by SLA, setup and training sessions, prioritized featu

<hr />

### Team
### Contacts

<VPTeamMembers size="small" :members="members" />
14 changes: 7 additions & 7 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
],
"dependencies": {
"@stepci/plugin-openapi": "^0.3.5",
"@stepci/runner": "^1.9.6",
"@stepci/runner": "^1.9.9",
"chalk": "^4.1.2",
"ci-info": "^3.5.0",
"cli-highlight": "^2.1.11",
Expand Down
4 changes: 2 additions & 2 deletions src/lib/utils.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { EnvironmentVariables } from '@stepci/runner'
import { WorkflowEnv } from '@stepci/runner'

// Check if env format matches the convention e.g. `variable=VARIABLE`
export const checkEnvFormat = (str: string) => str.match(/^(\w+=.+)$/)
Expand All @@ -8,5 +8,5 @@ export const checkOptionalEnvArrayFormat = (envs?: string[]) =>
envs?.length && !envs.every(checkEnvFormat)

// Parse every entry in optional env array to a key value pair and return as object
export const parseEnvArray = (env?: string[]): EnvironmentVariables =>
export const parseEnvArray = (env?: string[]): WorkflowEnv =>
Object.fromEntries(env?.map((opt) => opt.split('=')) ?? [])

0 comments on commit 25da927

Please sign in to comment.