Skip to content

Commit e65289a

Browse files
alokedesaialokedesai
authored
Merge branch 'main' into issue_templates
2 parents b163d5d + b5ee876 commit e65289a

70 files changed

Lines changed: 1059 additions & 27 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## Discord username (optional) please include so we can attribute you with our Contributor role (like so elvis#4747)
2+
3+
## Description of changes (updated or new workflows)

‎.github/workflows/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 0 additions & 3 deletions
This file was deleted.

‎LICENSE‎

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎README.md‎

Lines changed: 80 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,94 @@
11
# Workflows
22

3-
The repo for Workflows that appear within Warp and within [commands.dev](https://www.commands.dev/)
3+
The repo for all _public_ Workflows that appear within Warp and within [commands.dev](https://www.commands.dev/).
4+
5+
**To learn how to create local or repository workflows, see [our docs](https://docs.warp.dev/features/workflows#creating-custom-workflows).**
6+
7+
<img width="736" alt="image" src="https://user-images.githubusercontent.com/4110292/164031239-49f0ec9e-f124-44c4-89e6-6facc9bf9a8f.png">
8+
49

510
## What are Workflows?
611

712
Workflows are an easier way to execute and share commands within Warp. They are searchable by name, description, or command and are easily parameterized. See our documentation for more details: [https://docs.warp.dev/features/workflows](https://docs.warp.dev/features/workflows)
813

9-
## How Do I Access Workflows?
14+
## How Do I Access Workflows within Warp?
1015

11-
Workflows can be accessed within Warp directly within the app, either through the Command Palette or by pressing `ctrl-shift-r`.
16+
Workflows can be accessed directly within Warp, either through the Command Palette or by pressing `ctrl-shift-r`.
1217

1318
All public workflows (i.e. workflows within this repo) are also available at [commands.dev](https://www.commands.dev/).
1419

1520
## Contributing
16-
1721
Contributions are always welcome! If you have a workflow that would be useful to many Warp users, feel free to send a PR to add a Workflow spec.
1822

19-
The existing preset files should serve as an example for the format, while the a more comprehensive description of the file format is available in [FORMAT.md](FORMAT.md). Please request a review from someone on the Warp team once a PR is ready for review.
23+
All workflows are defined as YAML files within the [`specs/`](specs/) directory.
24+
25+
### File Format
26+
A comprehensive description of the file format is available in [FORMAT.md](FORMAT.md).
27+
Additionally, see the workflow below as an example to quickly get started:
28+
29+
```yaml
30+
---
31+
# The name of the workflow.
32+
name: Uninstall a Homebrew package and all of its dependencies
33+
# The corresponding command for the workflow. Any arguments should be surrounded with two curly braces. E.g `command {{arg}}`.
34+
command: |-
35+
brew tap beeftornado/rmtree
36+
brew rmtree {{package_name}}
37+
# Any tags that the workflow should be categorized with.
38+
tags:
39+
- homebrew
40+
# A description of the workflow.
41+
description: Uses the external command rmtree to remove a Homebrew package and all of its dependencies
42+
# List of arguments within the command.
43+
arguments:
44+
# Name of the argument within the command. This must exactly match the name of the argument
45+
# within the command (without the curly braces).
46+
- name: package_name
47+
# The description of the argument.
48+
description: The name of the package that should be removed
49+
# The default value for the argument.
50+
default_value: ~
51+
# The source URL for where the workflow was generated from, if any.
52+
source_url: "https://stackoverflow.com/questions/7323261/uninstall-remove-a-homebrew-package-including-all-its-dependencies"
53+
# The author of the workflow.
54+
author: Ory Band
55+
# The URL of original author of the Workflow. For example, if this workflow was generated from StackOverflow, the `author_url` would be the StackOverflow author's profile page.
56+
author_url: "https://stackoverflow.com/users/207894"
57+
# The valid shells where this workflow should be active. If valid for all shells, this can be left empty.
58+
# See FORMAT.md for the full list of accepted values.
59+
shells: []
60+
```
61+
62+
### Testing
63+
To test a workflow within Warp before submitting, you can use it as a local workflow within warp.
64+
65+
To do this:
66+
1) Copy the workflow to your local `~/.warp/workflows` directory:
67+
```bash
68+
mkdir -p ~/.warp/workflows && cp {{workflow}}.yaml; ~/.warp/workflows/
69+
```
70+
2) Open Warp and open workflows by pressing `ctrl-shift-r` or using the command palette.
71+
3) Click on "My Workflows" on the left to filter for local workflows.
72+
![README md — workflows 2022-04-19 at 11 52 53 AM](https://user-images.githubusercontent.com/4110292/164045025-8eb3dd66-260a-4b12-8a4b-beae563db8ee.jpg)
73+
4) Click on the workflow you've added and ensure all the information is correct.
74+
75+
To quickly test if a workflow file format is valid, you can also build workflows locally to validate the schema is correct:
76+
```
77+
# Download the rust toolchain, if not already installed.
78+
brew install rustup
79+
rustup-init
80+
81+
# Ensure the workflows can successfully be converted into Rust.
82+
cargo build
83+
```
84+
85+
86+
### What Makes a Useful workflow?
87+
A good workflow is one that includes a command with many flags or arguments or one that is hard to remember.
88+
89+
Additionally, a workflow _must_ include:
90+
91+
* A descriptive title that includes the name of the command--this is useful for improving the experience of searching for workflows in Warp or [commands.dev](https://www.commands.dev/).
92+
* A tag that accurately categorizes the workflows. Avoid many repetitive tags to improve searchability of workflows within Warp.
93+
* A description for the workflow and each of its arguments, if applicable.
94+
* A default value for each argument, if applicable.

‎build_ts/package-lock.json‎

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎build_ts/package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "warp-workflows",
3-
"version": "1.0.7",
3+
"version": "1.0.8",
44
"description": "Workflows used within Warp",
55
"main": "dist/warp-workflows.js",
66
"types": "dist/index.d.ts",

‎specs/cypress/open-cypress-default.yaml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
name: Open Cypress
2+
command: "npx cypress open"
3+
tags:
4+
- cypress
5+
description: "Open the Cypress Test Runner."
6+
source_url: "https://docs.cypress.io/guides/getting-started/installing-cypress#Opening-Cypress"
7+
author: cypress-dx
8+
shells: []

‎specs/cypress/open-cypress-mobile-viewport.yaml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
name: Open Cypress With a Mobile Viewport
2+
command: "npx cypress open --config viewportWidth={{width}},viewportHeight={{height}}"
3+
tags:
4+
- cypress
5+
description: "Open the Cypress Test Runner with a Mobile Viewport."
6+
arguments:
7+
- name: width
8+
description: The width of the viewport in pixels
9+
default_value: 375
10+
- name: height
11+
description: The height of the viewport in pixels
12+
default_value: 667
13+
source_url: "https://docs.cypress.io/guides/getting-started/installing-cypress#Opening-Cypress"
14+
author: cypress-dx
15+
shells: []

‎specs/cypress/run-cypress-default.yaml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
name: Run Cypress Headless
2+
command: "npx cypress run"
3+
tags:
4+
- cypress
5+
description: "Run Cypress in Headless Mode"
6+
source_url: "https://docs.cypress.io/guides/guides/command-line#cypress-run"
7+
author: cypress-dx
8+
shells: []

‎specs/cypress/run-cypress-mobile-viewport.yaml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
name: Run Cypress Headless With a Mobile Viewport
2+
command: "npx cypress run --config viewportWidth={{width}},viewportHeight={{height}}"
3+
tags:
4+
- cypress
5+
description: "Run the Cypress Test Runner with a Mobile Viewport in Headless Mode"
6+
arguments:
7+
- name: width
8+
description: The width of the viewport in pixels
9+
default_value: 375
10+
- name: height
11+
description: The height of the viewport in pixels
12+
default_value: 667
13+
source_url: "https://docs.cypress.io/guides/getting-started/installing-cypress#Opening-Cypress"
14+
author: cypress-dx
15+
shells: []

0 commit comments

Comments
 (0)