Skip to content

release-to-npm pr #2

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.

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
wants to merge 318 commits into
base: Release-to-NPM
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
318 commits
Select commit Hold shift + click to select a range
db881d6
Merge pull request #3 from eugene-codefresh/dcos-app-deploy
eugene-codefresh Dec 3, 2017
49d9009
dcos-app-deploy/plugin.yaml added
eugene-codefresh Dec 3, 2017
0b51c62
dcos-app-deploy plugin added to CATALOG.md
eugene-codefresh Dec 3, 2017
e7cad46
Add Jira plugin
antweiss Dec 5, 2017
a84008d
Update README.md
Dec 22, 2017
4b86841
Add docs for how to use custom vars
todaywasawesome Dec 28, 2017
6020ec2
Update docs to match master
todaywasawesome Dec 28, 2017
9dc2da4
Update README.md
vadim-codefresh Jan 10, 2018
1acdf9b
Update README.md
itai-codefresh Jan 23, 2018
f21bafa
adding twistlock scanning plugin from Steelcase
Jan 27, 2018
9bd5ed7
adding required plugin.yaml
dustinvanbuskirk Jan 27, 2018
83c3316
adding content to plugin.yaml
dustinvanbuskirk Jan 27, 2018
9b1b9a8
Merge pull request #19 from codefresh-io/add-twistlock-scan-from-stee…
alexei-led Jan 28, 2018
105835a
Merge pull request #18 from codefresh-io/jira
alexei-led Jan 28, 2018
a3648fc
need to update readme here to match plugin readme
dustinvanbuskirk Jan 31, 2018
68c7e58
Merge pull request #20 from codefresh-io/update-helm-plugin-readme
dustinvanbuskirk Feb 2, 2018
1e415db
new helm plugin
itaysk Feb 21, 2018
f6f3537
new helm readme change
itaysk Feb 21, 2018
c0f08c3
update example to avoid confision with private repos
itaysk Feb 28, 2018
4815cb0
clair
itaysk Mar 1, 2018
19d56c2
catalog update
itaysk Mar 7, 2018
a10e413
CMD_PS
itaysk Mar 14, 2018
4de36cd
Update README.md
itaysk Apr 26, 2018
3e3445c
doc link
itaysk May 4, 2018
f335a0f
reorg
itaysk May 9, 2018
8e6ad5c
fix urls
itaysk May 9, 2018
23e71bb
remove old helm
itaysk May 9, 2018
303f91e
fix urls
itaysk May 9, 2018
012966d
helm readme description
itaysk May 9, 2018
7fb121b
fix urls
itaysk May 9, 2018
90ea252
update docs; fix yaml
alexei-led May 30, 2018
021fa5e
Aligned content of columns with actual headers
kostis-codefresh Jun 4, 2018
0827a8b
Removed duplicate row
kostis-codefresh Jun 5, 2018
f336659
Create README.md
francisco-cocozza Jul 5, 2018
73315a5
Update README.md
francisco-cocozza Jul 5, 2018
a59af58
Update README.md
francisco-cocozza Jul 5, 2018
5e861a3
Update README.md
francisco-cocozza Jul 5, 2018
9b89d12
Update README.md
francisco-cocozza Jul 5, 2018
0d330a3
Update README.md
francisco-cocozza Jul 5, 2018
fd3e3d6
Update README.md
francisco-cocozza Jul 5, 2018
9ddb0be
Update README.md
francisco-cocozza Jul 5, 2018
090ba8b
Google KMS plugin
alex-codefresh Aug 28, 2018
c0aa249
Update README.md
francisco-cocozza Oct 9, 2018
f3d6607
fixed typo
nick-codefresh Nov 13, 2018
8364b1b
adding readme for cfstep-paclair
dustinvanbuskirk Dec 6, 2018
69065f6
Test plugin (#25)
verchol Dec 10, 2018
6106112
plugins_2018-12-10-04-54-47
Dec 10, 2018
a440915
plugins_2018-12-10-04-55-17
Dec 10, 2018
492a982
plugins_2018-12-10-04-55-44
Dec 10, 2018
4266f2f
plugins_2018-12-10-04-56-10
Dec 10, 2018
d8733ea
plugins_2018-12-10-04-56-43
Dec 10, 2018
4aa1ecd
plugins_2018-12-10-04-57-18
Dec 10, 2018
12d077b
plugins_2018-12-10-04-57-43
Dec 10, 2018
9facddd
plugins_2018-12-10-04-58-18
Dec 10, 2018
c6c1bc3
plugins_2018-12-10-04-58-44
Dec 10, 2018
340b22a
plugins_2018-12-10-04-59-14
Dec 10, 2018
5705cf2
plugins_2018-12-10-04-59-47
Dec 10, 2018
8779aca
plugins_2018-12-10-05-00-14
Dec 10, 2018
41bb9cd
plugins_2018-12-10-05-00-47
Dec 10, 2018
4481324
plugins_2018-12-10-05-01-14
Dec 10, 2018
3f6ef10
plugins_2018-12-10-05-01-50
Dec 10, 2018
149beeb
plugins_2018-12-10-05-02-11
Dec 10, 2018
a1390df
plugins_2018-12-10-05-02-35
Dec 10, 2018
48efefa
plugins_2018-12-10-05-03-02
Dec 10, 2018
3bf1dc0
plugins_2018-12-10-05-03-53
Dec 10, 2018
b7cca35
plugins_2018-12-10-05-04-28
Dec 10, 2018
e2706e2
plugins_2018-12-10-05-04-55
Dec 10, 2018
e1a0599
plugins_2018-12-10-05-05-21
Dec 10, 2018
8d2af2d
plugins_2018-12-10-05-05-44
Dec 10, 2018
d07a89b
plugins_2018-12-10-05-06-21
Dec 10, 2018
993e93e
plugins_2018-12-10-05-06-44
Dec 10, 2018
35e1516
plugins_2018-12-10-05-07-19
Dec 10, 2018
e44f67f
plugins_2018-12-10-05-07-45
Dec 10, 2018
844678b
plugins_2018-12-10-05-08-12
Dec 10, 2018
dc02a80
plugins_2018-12-10-05-08-35
Dec 10, 2018
d3e3d60
plugins_2018-12-10-05-09-03
Dec 10, 2018
4e86e77
plugins_2018-12-10-05-09-38
Dec 10, 2018
70397c7
plugins_2018-12-10-05-10-00
Dec 10, 2018
6e4e970
plugins_2018-12-10-05-10-24
Dec 10, 2018
4b06f9d
plugins_2018-12-10-05-10-48
Dec 10, 2018
98d2a6a
plugins_2018-12-10-05-11-15
Dec 10, 2018
3f5edd7
plugins_2018-12-10-05-11-49
Dec 10, 2018
d069ce7
plugins_2018-12-10-05-12-13
Dec 10, 2018
e87d219
plugins_2018-12-10-05-12-33
Dec 10, 2018
7eeca5a
plugins_2018-12-10-05-13-09
Dec 10, 2018
ba54fa6
plugins_2018-12-10-05-13-34
Dec 10, 2018
c947369
plugins_2018-12-10-05-14-05
Dec 10, 2018
4c9faa4
plugins_2018-12-10-05-14-38
Dec 10, 2018
441e675
plugins_2018-12-10-05-15-08
Dec 10, 2018
ef08294
plugins_2018-12-10-05-15-36
Dec 10, 2018
12eafa2
plugins_2018-12-10-05-16-04
Dec 10, 2018
dd165c1
plugins_2018-12-10-05-16-53
Dec 10, 2018
3ab0634
Update README.md
verchol Dec 10, 2018
314f1b7
plugins_2018-12-10-05-19-40
Dec 10, 2018
1c17b50
New Azure builder plugin
amir-codefresh Dec 11, 2018
b1018c2
New Azure builder plugin
amir-codefresh Dec 11, 2018
3c993f1
New Azure builder plugin
amir-codefresh Dec 11, 2018
668e63a
Merge pull request #27 from codefresh-io/azure-builder
amir-codefresh Dec 11, 2018
b153bf5
add new slack to plugin system
pasha-codefresh Dec 11, 2018
65632d6
Plugin GKE
kosta-codefresh Dec 11, 2018
a4f7b21
Plugin GKE
kosta-codefresh Dec 11, 2018
2be64a3
Merge pull request #28 from codefresh-io/slack-notifier
pasha-codefresh Dec 11, 2018
ea83cbf
pr operations
yaroslav-codefresh Dec 12, 2018
57163b3
main readme
yaroslav-codefresh Dec 12, 2018
505969a
Merge pull request #30 from codefresh-io/saas-1041-pr-operations
yaroslav-codefresh Dec 12, 2018
556cebd
Add github-relese plugin
alex-codefresh Dec 13, 2018
fcf1407
add default template
pasha-codefresh Dec 13, 2018
c80edce
Merge pull request #32 from codefresh-io/slack-notifier-default-template
pasha-codefresh Dec 14, 2018
caf4b0b
Merge pull request #31 from codefresh-io/github-release-plugin
amir-codefresh Dec 18, 2018
33b0512
Merge pull request #23 from dustinvanbuskirk/add-cfstep-paclair
amir-codefresh Dec 18, 2018
6d0c9ac
Merge branch 'master' into plugin-gke
amir-codefresh Dec 18, 2018
5c45d07
Merge pull request #29 from codefresh-io/plugin-gke
amir-codefresh Dec 18, 2018
a5c48ed
Dynamic catalog (#37)
verchol Dec 19, 2018
060b0a1
Anchore scan plugin (#36)
valancej Dec 19, 2018
cb13285
add twilio plugin manifest
pasha-codefresh Dec 20, 2018
20c90a9
plugins_2018-12-20-09-38-49
Dec 20, 2018
aeb75c9
plugins_2018-12-20-09-39-21
Dec 20, 2018
5629ef9
plugins_2018-12-20-09-39-51
Dec 20, 2018
0894db2
plugins_2018-12-20-09-40-22
Dec 20, 2018
481d49a
plugins_2018-12-20-09-40-51
Dec 20, 2018
128b73c
plugins_2018-12-20-10-30-23
Dec 20, 2018
c681512
plugins_2018-12-20-10-30-55
Dec 20, 2018
65d7e50
plugins_2018-12-20-10-32-14
Dec 20, 2018
458a153
plugins_2018-12-20-10-32-46
Dec 20, 2018
21c2354
plugins_2018-12-20-10-33-16
Dec 20, 2018
846cbae
Merge pull request #38 from codefresh-io/add-twilio-plugin
pasha-codefresh Dec 20, 2018
430e222
add sendgrid plugin manifest
pasha-codefresh Dec 24, 2018
32d3e01
plugins_2018-12-24-10-27-14
Dec 24, 2018
5615b8c
plugins_2018-12-24-10-27-45
Dec 24, 2018
a843ee3
plugins_2018-12-24-10-28-31
Dec 24, 2018
b617866
plugins_2018-12-24-11-23-24
Dec 24, 2018
00b07a4
plugins_2018-12-24-11-23-46
Dec 24, 2018
6f8b9b6
plugins_2018-12-24-11-24-32
Dec 24, 2018
9c12aa4
plugins_2018-12-24-11-25-00
Dec 24, 2018
debfb9a
plugins_2018-12-24-11-25-28
Dec 24, 2018
6b2a978
plugins_2018-12-24-11-26-07
Dec 24, 2018
ce11daa
plugins_2018-12-24-11-26-42
Dec 24, 2018
e1f93a9
plugins_2018-12-24-11-27-09
Dec 24, 2018
73cc664
plugins_2018-12-24-11-27-36
Dec 24, 2018
7252ba7
plugins_2018-12-24-11-28-13
Dec 24, 2018
532d8d2
plugins_2018-12-24-11-28-35
Dec 24, 2018
bd58990
plugins_2018-12-24-11-28-58
Dec 24, 2018
2c19b59
plugins_2018-12-24-11-30-22
Dec 24, 2018
e0c9929
plugins_2018-12-24-11-30-46
Dec 24, 2018
a78dcc2
plugins_2018-12-24-11-31-14
Dec 24, 2018
a43f7a2
Merge pull request #39 from codefresh-io/sendgrid
pasha-codefresh Dec 24, 2018
aa7474b
Update README.md
amir-codefresh Dec 26, 2018
a457d04
plugins_2018-12-26-12-33-23
Dec 26, 2018
e324a42
plugins_2018-12-26-12-33-59
Dec 26, 2018
5cfde86
plugins_2018-12-26-12-34-23
Dec 26, 2018
9163873
plugins_2018-12-26-12-35-00
Dec 26, 2018
f00fe96
plugins_2018-12-26-12-35-38
Dec 26, 2018
37d90c8
plugins_2018-12-26-12-36-08
Dec 26, 2018
dee033e
plugins_2018-12-26-12-36-34
Dec 26, 2018
7645c4c
plugins_2018-12-26-12-37-03
Dec 26, 2018
f51b288
plugins_2018-12-26-12-37-39
Dec 26, 2018
0fcc369
plugins_2018-12-26-12-38-04
Dec 26, 2018
acc5b59
plugins_2018-12-26-12-38-33
Dec 26, 2018
e75f79c
plugins_2018-12-26-12-39-08
Dec 26, 2018
6710f20
plugins_2018-12-26-12-39-33
Dec 26, 2018
85d3b40
adding new vars
amir-codefresh Dec 26, 2018
108ff52
plugins_2018-12-26-12-57-46
Dec 26, 2018
61d2e14
plugins_2018-12-26-12-58-13
Dec 26, 2018
15a6900
plugins_2018-12-26-12-58-34
Dec 26, 2018
232a688
plugins_2018-12-26-12-58-53
Dec 26, 2018
f32b0ad
plugins_2018-12-26-12-59-12
Dec 26, 2018
92724d0
plugins_2018-12-26-12-59-29
Dec 26, 2018
b020794
Merge pull request #40 from codefresh-io/support-user-creds
amir-codefresh Dec 26, 2018
7c8ac5a
gitsubmodules plugin
francisco-cocozza Dec 26, 2018
69cd603
extra line
francisco-cocozza Dec 26, 2018
536d7ff
fix new line
francisco-cocozza Dec 26, 2018
a37baa8
Adding CF_SUBMODULE_UPDATE_RECURSIVE option
francisco-cocozza Dec 27, 2018
a1fd863
plugins_2018-12-27-22-12-19
Dec 27, 2018
ca2050f
plugins_2018-12-27-22-12-41
Dec 27, 2018
31d198f
plugins_2018-12-27-22-13-08
Dec 27, 2018
4be872b
plugins_2018-12-27-22-13-37
Dec 27, 2018
140eb85
plugins_2018-12-27-22-14-11
Dec 27, 2018
eacc95b
plugins_2018-12-27-22-14-32
Dec 27, 2018
578186c
plugins_2018-12-27-22-15-10
Dec 27, 2018
1d559f7
plugins_2018-12-27-22-15-35
Dec 27, 2018
00c62c8
plugins_2018-12-27-22-16-07
Dec 27, 2018
c3d23af
plugins_2018-12-27-22-16-28
Dec 27, 2018
7e7925a
plugins_2018-12-27-22-16-53
Dec 27, 2018
1c87495
plugins_2018-12-27-22-17-13
Dec 27, 2018
4d603fe
plugins_2018-12-27-22-17-38
Dec 27, 2018
30d41aa
plugins_2018-12-27-22-17-58
Dec 27, 2018
0eef2b0
plugins_2018-12-27-22-18-28
Dec 27, 2018
e56b1ee
plugins_2018-12-27-22-18-50
Dec 27, 2018
3a7ec31
plugins_2018-12-27-22-19-22
Dec 27, 2018
b1860a6
plugins_2018-12-27-22-19-52
Dec 27, 2018
1e2a4ea
plugins_2018-12-27-22-20-20
Dec 27, 2018
5390092
plugins_2018-12-27-22-20-40
Dec 27, 2018
f4b1275
plugins_2018-12-27-22-21-10
Dec 27, 2018
0a25c7a
plugins_2018-12-27-22-21-36
Dec 27, 2018
c70810e
plugins_2018-12-27-22-21-58
Dec 27, 2018
1bc714f
plugins_2018-12-27-22-22-20
Dec 27, 2018
16063e3
plugins_2018-12-27-22-22-56
Dec 27, 2018
ba32d63
plugins_2018-12-27-22-23-23
Dec 27, 2018
e8f8b00
plugins_2018-12-27-22-23-51
Dec 27, 2018
e802af3
plugins_2018-12-27-22-24-21
Dec 27, 2018
a6f3574
plugins_2018-12-27-22-24-43
Dec 27, 2018
bf6dab8
plugins_2018-12-27-22-25-03
Dec 27, 2018
9163012
plugins_2018-12-27-22-25-37
Dec 27, 2018
fd11853
plugins_2018-12-27-22-26-07
Dec 27, 2018
40733e3
plugins_2018-12-27-22-26-28
Dec 27, 2018
9e88c04
plugins_2018-12-27-22-26-49
Dec 27, 2018
2aec706
plugins_2018-12-27-22-27-10
Dec 27, 2018
c895218
plugins_2018-12-27-22-27-39
Dec 27, 2018
3bee0de
plugins_2018-12-27-22-28-09
Dec 27, 2018
b945f53
plugins_2018-12-27-22-28-29
Dec 27, 2018
c11576d
plugins_2018-12-27-22-28-51
Dec 27, 2018
5e64b94
plugins_2018-12-27-22-29-11
Dec 27, 2018
62114de
plugins_2018-12-27-22-29-37
Dec 27, 2018
0c2ed0e
plugins_2018-12-27-22-29-58
Dec 27, 2018
8a6b572
plugins_2018-12-27-22-30-23
Dec 27, 2018
57c858b
plugins_2018-12-27-22-30-51
Dec 27, 2018
35d3d90
plugins_2018-12-27-22-31-12
Dec 27, 2018
ec1f8bd
plugins_2018-12-27-22-31-33
Dec 27, 2018
e67de63
plugins_2018-12-27-22-32-09
Dec 27, 2018
5630fdf
plugins_2018-12-27-22-32-36
Dec 27, 2018
e617f1e
plugins_2018-12-27-22-33-08
Dec 27, 2018
a66e886
plugins_2018-12-27-22-33-28
Dec 27, 2018
fcecfba
plugins_2018-12-27-22-33-51
Dec 27, 2018
a5ae8d5
plugins_2018-12-27-22-34-21
Dec 27, 2018
1f72c3f
plugins_2018-12-27-22-34-43
Dec 27, 2018
a36388e
plugins_2018-12-27-22-35-06
Dec 27, 2018
ff375b9
plugins_2018-12-27-22-35-27
Dec 27, 2018
270c87d
plugins_2018-12-27-22-35-51
Dec 27, 2018
ba96738
plugins_2018-12-27-22-36-13
Dec 27, 2018
84e84cc
plugins_2018-12-27-22-36-38
Dec 27, 2018
729997d
plugins_2018-12-27-22-37-08
Dec 27, 2018
10b74c3
plugins_2018-12-27-22-37-30
Dec 27, 2018
a849d18
plugins_2018-12-27-22-37-47
Dec 27, 2018
5f40f25
Makisu plugin
alex-codefresh Dec 29, 2018
1794926
Move the github-release to the proper location
alex-codefresh Dec 29, 2018
2d3d661
Merge pull request #41 from codefresh-io/gitsubmodules
francisco-cocozza Jan 4, 2019
4752e4b
azure-builder - fix some typos and formatting in README.md
Jan 7, 2019
7b7858f
Merge pull request #44 from codefresh-io/azure-builder-typos
amir-codefresh Jan 7, 2019
befa414
Merge pull request #42 from codefresh-io/a-patch
amir-codefresh Jan 7, 2019
a3aea99
Merge pull request #43 from codefresh-io/SAAS-1248
alex-codefresh Jan 8, 2019
efa4668
Adding gitclonerssh plugin
francisco-cocozza Jan 14, 2019
aa87108
Adding clarification for SSH_KEY documentation
francisco-cocozza Jan 14, 2019
983fd4a
Move github-release plugin to correct folder
Jan 14, 2019
1aa9025
Merge pull request #46 from codefresh-io/gitclonerssh
amir-codefresh Jan 14, 2019
616b998
Merge pull request #45 from codefresh-io/move-github-release-plugin
amir-codefresh Jan 14, 2019
9ba6886
Vault plugin (#47)
alexaladov-codefresh Jan 17, 2019
4448b70
Fix documentation links (#48)
antweiss Jan 21, 2019
796305a
Update env variable description (#50)
andrii-codefresh Jan 28, 2019
e79999e
Gitter notifier (#51)
andrii-codefresh Feb 1, 2019
35c89f7
telegram notifier (#49)
andrii-codefresh Feb 1, 2019
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
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.idea/
node_modules
13 changes: 0 additions & 13 deletions CATALOG.md

This file was deleted.

5 changes: 3 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,9 @@ This repository is used by Plugin developers for maintaining the official plugin

### How to Contribute a Plugin

1. Fork this repository, develop and test your Plugin
2. Choose the correct folder for your plugin based on the information in the [Repository Structure](README.md#repository-structure) section
1. Develop and test your plugin
2. Fork this repository
2. Choose the correct folder for your plugin based on the information in the [Repository Structure](docs/plugin.md#plugin-file-structure) section
3. Ensure your Plugin follows the [technical](#technical-requirements) and [documentation](#documentation-requirements) guidelines, described below
4. Update [Plugin Catalog](CATALOG.md)
5. Submit a pull request
Expand Down
87 changes: 27 additions & 60 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,60 +1,27 @@
# Codefresh Plugins

Use this repository to submit official Plugins for Codefresh. Plugins are curated automated step definitions for Codefresh. For more information about using Codefresh, see its
[documentation](https://docs.codefresh.io).

## How do I install these plugins?

Codefresh Plugins are available as plain Docker images. As long as Plugin Docker image is accessible, Codefresh can use it for its pipelines.

## How do I use plugins from the Incubator repository?

*TBD*

## Codefresh Plugin Format

Take a look at the [example plugin](#) for reference when you're writing your first few plugins.

The Plugin folder must contain `plugin.yaml` and `README.md` files.

Before contributing a Plugin, become familiar with the format. Note that the project is still under active development and the format may still evolve a bit.

## Repository Structure

This GitHub repository contains the source for the packaged and versioned plugins released in the [`gs://codefresh-plugins` Google Storage bucket](https://console.cloud.google.com/storage/browser/codefresh-plugins/) (the Plugins Repository).

The Plugins in the `stable/` directory in the master branch of this repository match the latest packaged Plugins in the Plugin Repository, though there may be previous versions of a Plugin available in that Plugin Repository.

The purpose of this repository is to provide a place for maintaining and contributing official Plugins, with CI processes in place for managing the releasing of Plugins into the Plugin Repository.

The Plugins in this repository are organized into two folders:
* stable
* incubator

Stable Plugins meet the criteria in the [technical requirements](CONTRIBUTING.md#technical-requirements).

Incubator Plugins are those that do not meet these criteria. Having the incubator folder allows plugins to be shared and improved on until they are ready to be moved into the stable folder. The plugins in the `incubator/` directory can be found in the [`gs://codefresh-plugins-incubator` Google Storage Bucket](https://console.cloud.google.com/storage/browser/codefresh-plugins-incubator).

In order to get a Plugin from incubator to stable, Plugin maintainers should open a pull request that moves the plugin folder.

## Contributing a Plugin

We'd love for you to contribute a Plugin that provides a useful automated step for Codefresh. Please read our [Contribution Guide](CONTRIBUTING.md) for more information on how you can contribute Plugins.

## Review Process

The following outlines the review procedure used by the Plugin repository maintainers. Github labels are used to indicate state change during the review process.

* ***AWAITING REVIEW*** - Initial triage which indicates that the PR is ready for review by the maintainers team. All e2e tests must pass in-order to move to this state
* ***CHANGES NEEDED*** - Review completed by at least one maintainer and changes needed by contributor (explicit even when using the review feature of Github)
* ***CODE REVIEWED*** - The plugin structure has been reviewed and found to be satisfactory given the [technical requirements](CONTRIBUTING.md#technical-requirements) (may happen in parallel to UX REVIEWED)
* ***UX REVIEWED*** - The plugin installation UX has been reviewed and found to be satisfactory. (may happen in parallel to CODE REVIEWED)
* ***LGTM*** - Added ONLY once both UX/CODE reviewed are both present. Merge must be handled by someone OTHER than the maintainer that added the LGTM label. This label indicates that given a quick pass of the comments this change is ready to merge

### Stale Pull Requests

After initial review feedback, if no updates have been made to the pull request for 1 week, the `stale` label will be added. If after another week there are still no updates it will be closed. Please re-open if/when you have made the proper adjustments.

## Status of the Project

This project is still under active development, so you might run into [issues](https://github.com/codefresh-io/plugins/issues). If you do, please don't be shy about letting us know, or better yet, contribute a fix or feature.
# Codefresh plugins

Codefresh Plugins are Docker images made especially for use in Codefresh freestyle steps. Each plugin facilitates a common task that would otherwise be difficult to achieve.
See each plugin readme for more info and usage instructions.

## Plugins

| Plugin| Description| Tags|
| --- | --- | --- |
| [Helm](plugins/helm/README.md) | Deploy Helm charts | `kubernetes` `helm`|
| [Codefresh Cli](plugins/codefresh-cli/README.md) | Operate on Codefresh resources | `cli` `codefresh`|
| [Slack](plugins/slack/README.md)| Send message to slack| `slack` `notify`|
| [Deploy to ECS](plugins/ecs-deploy/README.md)| Deploy docker image to ECS| `ecs` `deploy` `containers` `aws` |
| [Deploy Kompose](plugins/kompose/README.md)| Deploy Docker Compose to Kubernetes cluster with Kubernetes [Kompose](http://kompose.io) | `docker` `docker-compose` `kompose` `deploy` `kubernetes` |
| [GitHub PR](plugins/github-pr/README.MD)| Operates on pull requests on GitHub | `github` `pull-request` |
| [Run Jenkins Jobs](plugins/run-jenkins-job/README.md)| Run jenkins job from codefresh pipeline| `jenkins` `job`|
| [Deploy to DCOS](plugins/dcos-app-deploy/README.md) | Deploy application image to DC/OS cluster | `dcos` `deploy` `containers` |
| [Interact with Jira](plugins/jira/README.md) | Interact with Jira from codefresh pipelines| `jira` `workflow`|
| [Makisu](plugins/makisu/README.md) | Building images using the Makisu tool | `makisu` `uber`|
| [release to npm](plugins/release-to-NPM/README.md) | Release npm modules from a pipeline | `npm` |
| [Twistlock](plugins/cfstep-twistlock) | Security scanning of docker images using Twistlock | `security` |
| [Clair](plugins/clair/README.md) | Security scanning of Docker images using Clair | `security` |
| [Import Docker Images](plugins/import-docker-images/README.md) | Import Docker images metadata into Codefresh| `docker` `codefresh`|
| [Google KMS](plugins/google-kms/README.md) | Encryption/Decryption with Google KMS| `KMS` `codefresh`|
| [Github Release](plugins/github-release/README.md) | Managing GitHub releases | `github` `release`|
| [Google GKE](plugins/gke/README.md) | GKE Clusters | `GKE` `codefresh`|
| [Vault](plugins/vault/README.md) | Export Vault Key/Value pairs as ENV variables | `Vault` `codefresh`|
8 changes: 5 additions & 3 deletions docs/plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ then they can be packaged into versioned archives to be deployed.
This document explains the plugin format, and provides basic guidance for
building plugins.

## The Plugin File Structure
## Plugin File Structure

A plugin is organized as a collection of files inside of a directory. The
directory name is the name of the plugin (without versioning information). Thus,
Expand All @@ -17,7 +17,7 @@ Inside of this directory, Codefresh will expect a structure that matches this:
```
kube-deploy/
plugin.yaml # A YAML file containing information about the plugin
LICENSE # OPTIONAL: A plain text file containing the license for the chart
LICENSE # OPTIONAL: A plain text file containing the license for the plugin
README.md # OPTIONAL: A human-readable README file
NOTES.md # OPTIONAL: A plain text file containing short usage notes
```
Expand Down Expand Up @@ -50,6 +50,8 @@ volumes:
- name: The volume name
required: true | false (default "false")
description: A short description for attached volume
context:
- kind: Codefresh context kind to inject automatically to the plugin
```


Expand Down Expand Up @@ -93,4 +95,4 @@ cannot be overridden.
### Predefined Volumes and Files

- `/codefresh/volume` - same volume mounted to all steps running in Codefresh pipeline
- `/codefresh/volume/env_vars_to_export` - a placeholder file to filled with **exported** environment variables; any exported variable can be used in subsequent pipeline steps
- `/codefresh/volume/env_vars_to_export` - a placeholder file to be filled with **exported** environment variables; any exported variable can be used in subsequent pipeline steps
30 changes: 30 additions & 0 deletions dynamic-catalog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# **Catalog**
Created at ** Thu Dec 27 2018 22:37:47 GMT+0000 (Coordinated Universal Time)**


| Plugin Name | Image | Description | source | Tags |
| ------------- |-------------| ---- |-----|----|
| azure-builder | codefresh/cf-azure-builder | Docker build in Azure ACR | https://github.com/codefresh-io/azure-build-plugin | **`docker`** **`azure`** |
| clair | codefresh/klar:master | Scan an image with Clair | https://github.com/optiopay/klar | **`clair`** **`security`** |
| codefresh-cli | codefresh/cli | Operate on Codefresh resources | https://github.com/codefresh-io/codefresh | **`cli`** |
| dcos-app-deploy | codefresh/cf-deploy-dcos | Deploy an application on dcos cluster | https://github.com/codefresh-io/cf-deploy-dcos | **`dcos`** **`deploy`** **`deployment`** |
| docker-service | codefresh/docker-service | Codefresh docker-service plugin | https://github.com/codefresh-io/docker-service | **`docker`** **`docker-machine`** **`docker-compose`** |
| ecs-deploy | codefresh/ecs | Release a Helm chart (update or install) | https://github.com/codefresh-io/cf-deploy-ecs.git | **`ecs`** **`deploy`** **`containers`** |
| github-pr | codefresh/github-pr-plugin | Operates on GitHub pull requests | https://github.com/codefresh-io/github-pr-plugin | **`docker`** **`github`** **`pull-request`** |
| gitsubmodules | codefresh/cfstep-gitsubmodules | Update git submodules | https://github.com/codefresh-io/cfstep-gitsubmodules | **`git`** **`submodules`** |
| gke | codefresh/plugin-gke | Codefresh gke plugin | https://github.com/codefresh-io/plugin-gke | **`kubernetes`** **`gke`** **`gcloud`** |
| helm | codefresh/cfstep-helm | Release a Helm chart (update or install) | https://github.com/codefresh-contrib/cfplugin-step | **`helm`** **`kubernetes`** |
| helm-legacy | codefresh/plugin-helm | Release a Helm chart (update or install). There is a new Helm plugin with added capabilities, we are keeping this plugin as is for backward-compatibility. The new plugin is at /incubator/helm (https://github.com/codefresh-io/plugins/tree/master/incubator/helm) | https://github.com/codefresh-io/cf-plugin-helm | **`helm`** **`kubernetes`** |
| import-docker-images | codefresh/import-images | Import metadata for existing Docker images into Codefresh | https://github.com/codefresh-io/cf-import-image | **`docker`** |
| jira | otomato/jira-cli | Update a Jira ticket | https://github.com/codefreshdemo/jira-cli-docker | **`jira`** |
| kompose | codefresh/plugin-helm | Release a Docker Compose to Kubernetes | https://github.com/codefresh-io/cf-kompose-plugin | **`docker-compose`** **`docker`** **`kompose`** **`kubernetes`** |
| release-to-NPM | | | | |
| run-jenkins-job | codefresh/run-jenkins-jobs | Run jenkins job from codefresh pipeline | https://github.com/codefresh-io/cf-run-jenkins-jobs | **`docker`** **`jenkins`** |
| sendgrid | codefresh/sendgridplugin | Send e-mail via Sendgrid | https://github.com/codefresh-io/sendgridplugin | **`mail`** **`sendgrid`** |
| slack | codefresh/slack-message-sender | Send message to slack channel | https://github.com/codefresh-io/slack-message-sender | **`slack`** |
| slack-notifier | codefresh/slacknotifier | Send message to slack channel | https://github.com/codefresh-io/slack-notifier | **`slack`** |
| testplugin | codefresh/github-pr-plugin | Creates GitHub pull request | https://github.com/codefresh-io/github-pr-plugin | **`testplugin`** |
| testplugin1 | codefresh/github-pr-plugin | test plugin1! | https://github.com/codefresh-io/github-pr-plugin | **`testplugin1`** |
| twilio | codefresh/twilioplugin | Send SMS message via Twilio | https://github.com/codefresh-io/twillio-plugin | **`sms`** **`twilio`** |
| versioner | docker.io/codefresh/versioner | semver versions builder | https://github.com/codefresh-io/cf-plugin-versioner.git | **`versioner 1.0`** |

File renamed without changes.
77 changes: 77 additions & 0 deletions plugins/anchore/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
# Codefresh Anchore Plugin

Anchore is a service that analyzes Docker images and generates a detailed manifest of the image, a virtual ‘bill of materials’ that includes official operating system packages, unofficial packages, configuration files, and language modules and artifacts. Anchore policies can they be defined to govern security vulnerabilities, package whitelists and blacklists, configuration file contents, presence of credentials in image, manifest changes, exposed ports or any user defined checks. These policies can be deployed site wide or customized for specific images or categories of applications.

For more information view the github repo here: https://github.com/anchore/anchore-engine

## Prerequisites

- Codefresh subscription
- Running Anchore Engine service

### Reference

- Example `codefresh.yml`: https://raw.githubusercontent.com/valancej/plugins/master/plugins/anchore/codefresh.yml
- Github repo containing Dockerfile: https://github.com/valancej/node_critical_fail
- Anchore Documentation: https://anchore.freshdesk.com/support/home
- Anchore CLI Image: https://hub.docker.com/r/anchore/engine-cli/

## Example

In this example, we will scan an image built by Codefresh. Depending on the result of the Anchore policy evaluation, we will choose to push the image to Dockerhub or not.

### Setup

The example setup is described below.

### Environment Variables

These environment variables can be set within Codefresh pipeline configuration.

Name|Required|Description
---|---|---
ANCHORE_CLI_URL|Yes|The address of the Anchore server
ANCHORE_CLI_USER|Yes|Anchore account name
ANCHORE_CLI_PASS|Yes|Anchore account password
ANCHORE_FAIL_ON_POLICY|No|Fail build if policy evaluation fails
QA_IMAGE|No|Image built and scanned
dockerhubUsername|No|Dockerhub account name
dockerhubPassword|No|Dockerhub account password

### Codefresh.yml

```yaml
version: '1.0'
steps:
MyDockerImage:
title: Building Docker Image
type: build
image_name: ${{QA_IMAGE}}
working_directory: ./
tag: latest
dockerfile: Dockerfile
metadata:
set:
- QA: Pending Anchore scan before push to Dockerhub..
ScanMyImage:
title: Scanning Docker Image
image: anchore/engine-cli:latest
commands:
- echo "Scanning image with Anchore"
- anchore-cli image add ${{QA_IMAGE}}
- echo "Waiting for analysis to complete"
- anchore-cli image wait ${{QA_IMAGE}}
- echo "Analysis complete"
- if [ "${{ANCHORE_FAIL_ON_POLICY}}" == "true" ] ; then anchore-cli evaluate check ${{QA_IMAGE}}; fi
PushImage:
title: Pushing Docker Image
description: Pushing Docker Image to Dockerhub...
type: push
candidate: '${{MyDockerImage}}'
image_name: jvalance/node_critical_fail
tag: latest
registry: docker.io
credentials:
username: '${{dockerhubUsername}}'
password: '${{dockerhubPassword}}'
```
33 changes: 33 additions & 0 deletions plugins/anchore/codefresh.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
version: '1.0'
steps:
MyDockerImage:
title: Building Docker Image
type: build
image_name: ${{QA_IMAGE}}
working_directory: ./
tag: latest
dockerfile: Dockerfile
metadata:
set:
- QA: Pending Anchore scan..
ScanMyImage:
title: Scanning Docker Image
image: anchore/engine-cli:latest
commands:
- echo "Scanning image with Anchore"
- anchore-cli image add ${{QA_IMAGE}}
- echo "Waiting for analysis to complete"
- anchore-cli image wait ${{QA_IMAGE}}
- echo "Analysis complete"
- if [ "${{ANCHORE_FAIL_ON_POLICY}}" == "true" ] ; then anchore-cli evaluate check ${{QA_IMAGE}}; fi
PushImage:
title: Pushing Docker Image
description: Pushing Docker Image to Dockerhub...
type: push
candidate: '${{MyDockerImage}}'
image_name: jvalance/node_critical_fail
tag: latest
registry: docker.io
credentials:
username: '${{dockerhubUsername}}'
password: '${{dockerhubPassword}}'
50 changes: 50 additions & 0 deletions plugins/aqua-scan/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
FROM ubuntu:xenial

ENV LANG C.UTF-8

RUN { \
echo '#!/bin/sh'; \
echo 'set -e'; \
echo; \
echo 'dirname "$(dirname "$(readlink -f "$(which javac || which java)")")"'; \
} > /usr/local/bin/docker-java-home && \
chmod +x /usr/local/bin/docker-java-home

RUN apt-get update && apt-get install -y --no-install-recommends \
bzip2 \
unzip \
xz-utils \
apt-transport-https \
ca-certificates \
curl \
software-properties-common \
python3-openssl && \
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | apt-key add - && \
add-apt-repository \
"deb [arch=amd64] https://download.docker.com/linux/ubuntu \
$(lsb_release -cs) \
stable" && \
apt-get update && apt-get install -y --no-install-recommends \
docker-ce=17.09.0~ce-0~ubuntu && \
apt-get install -y \
openjdk-8-jre \
; \
rm -rf /var/lib/apt/lists/*; \
\
[ "$JAVA_HOME" = "$(docker-java-home)" ]; \
\
update-alternatives --get-selections | awk -v home="$JAVA_HOME" 'index($3, home) == 1 { $2 = "manual"; print | "update-alternatives --set-selections" }'; \
update-alternatives --query java | grep -q 'Status: manual' && \
mkdir /packages && \
curl -o /packages/twistcli https://cdn.twistlock.com/support/twistcli && \
curl -o /packages/nexus-iq-cli-1.38.0-02.jar https://download.sonatype.com/clm/scanner/nexus-iq-cli-1.38.0-02.jar

COPY scripts /scripts

RUN chmod +x -R /packages
RUN chmod +x -R /scripts

WORKDIR /scripts

ENTRYPOINT ["/usr/bin/python3"]
CMD [""]
Loading