Skip to content
This repository was archived by the owner on Mar 16, 2025. It is now read-only.

Commit 808cb06

Browse files
committed
add features
1 parent 396fa3c commit 808cb06

File tree

2 files changed

+46
-28
lines changed

2 files changed

+46
-28
lines changed

FEATURES.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Github Workflow Syntax Supported Features
2+
3+
### General
4+
5+
| Feature | Supported | Reference |
6+
| --------------------------------------------------------------------- | :-------: | ------------------------------------------------------------------------------------------------------------------------------------------------ |
7+
| name || https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#name |
8+
| run-name || https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#run-name |
9+
| on || https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#on |
10+
| on.<event_name>.types || https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#onevent_nametypes |
11+
| on.on.<pull_request\|pull_request_target>.<branches\|branches-ignore> || https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#onpull_requestpull_request_targetbranchesbranches-ignore |
12+
13+
### On
14+
15+
| on | ✅ | https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#on
16+
| on.

README.md

Lines changed: 30 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,36 @@ updates the YAML configuration files, ensuring seamless integration with GitHub.
1111
>
1212
> Since October is the hacktoberfest month, this project use `AppWrite Cloud (Free tier)` for their [Appwrite’s Hacktoberfest 2024 Hackathon](https://appwrite.io/blog/post/appwrite-hacktoberfest-hackathon-2024).
1313
14-
## 🤖 Tech stack
14+
## Features
15+
16+
### ✅ Built-in editor
17+
18+
Visualize and/or modify your workflow file through a simple UI.
19+
20+
- View your steps dependency graph through the main interactive canvas
21+
- Check your workflow validity through the YAML Viewer and it's linter, which immediately tell you if your file respect the [GitHub Workflow Syntax](https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions) thanks to the GitHub Language Service integration.
22+
- Modify your workflow file updating the Properties panel in the right side.
23+
24+
[Read here all available editor features](./FEATURES.md)
25+
26+
![Built-in editor](./docs/327shots_so.png)
27+
28+
### ✅ Search for existing GitHub workflows
29+
30+
What if you already have an existing workflow file pushed in your repository? You can use the built-in search to get all workflows
31+
of your repository.
32+
33+
![Search for existing github workflows](./docs/262shots_so.png)
34+
35+
### ✅ Create your own workflows files
36+
37+
If you haven't an existing workflow file, you can create it from scratch if you're authenticated.
38+
39+
Workflow files are persisted into [AppWrite Cloud](https://appwrite.io/) and **are publicly readable to everyone that has the link**.
40+
41+
![Create scratches](./docs/577shots_so.png)
42+
43+
## 🤖 Technical info
1544

1645
PipelineUI is entirely built with [Solid](https://github.com/solidjs/solid) and [SolidStart](https://github.com/solidjs/solid-start).
1746

@@ -100,33 +129,6 @@ This application is hosted on Railway. Deploy are made via github action CI/CD
100129
- [Workflow file](./.github/workflows/deploy.yml)
101130
- [See the workflow file on PipelineUI](https://pipelineui.dev/editor/riccardoperra/pipelineui/main/.github/workflows/deploy.yml)
102131

103-
## Features
104-
105-
### ✅ Search for existing GitHub workflows
106-
107-
What if you already have an existing workflow file pushed in your repository? You can use the built-in search to get all workflows
108-
of your repository.
109-
110-
![Search for existing github workflows](./docs/262shots_so.png)
111-
112-
### ✅ Create your own workflows files
113-
114-
If you haven't an existing workflow file, you can create it from scratch if you're authenticated.
115-
116-
Workflow files are persisted into [AppWrite Cloud](https://appwrite.io/) and **are publicly readable to everyone that has the link**.
117-
118-
![Create scratches](./docs/577shots_so.png)
119-
120-
### ✅ Built-in editor
121-
122-
Visualize and/or modify your workflow file through a simple UI.
123-
124-
- View your steps dependency graph through the main interactive canvas
125-
- Check your workflow validity through the YAML Viewer and it's linter, which immediately tell you if your file respect the [GitHub Workflow Syntax](https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions) thanks to the GitHub Language Service integration.
126-
- Modify your workflow file updating the Properties panel in the right side.
127-
128-
![Built-in editor](./docs/327shots_so.png)
129-
130132
## Supported GitHub Workflow features
131133

132134
- [ ] [Name](https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#name)

0 commit comments

Comments
 (0)