Skip to content

Commit e65993e

Browse files
authored
Merge pull request #1 from hellofresh/EES-5082
Pipeline and readme
2 parents 74e6975 + f88be15 commit e65993e

File tree

3 files changed

+363
-2
lines changed

3 files changed

+363
-2
lines changed

.github/workflows/release.yml

Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
name: Build Artifacts
2+
3+
on:
4+
release:
5+
types:
6+
- created
7+
8+
jobs:
9+
linux:
10+
name: linux@amd64
11+
runs-on: ubuntu-latest
12+
13+
steps:
14+
- name: Get release
15+
id: get_release
16+
uses: bruceadams/[email protected]
17+
env:
18+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
19+
20+
- name: Checkout
21+
uses: actions/checkout@v2
22+
with:
23+
repository: grpc/grpc
24+
ref: ${{ steps.get_release.outputs.tag_name }}
25+
26+
- name: Install Basilisk
27+
run: |
28+
wget https://github.com/bazelbuild/bazelisk/releases/download/v1.7.5/bazelisk-linux-amd64
29+
chmod a+x bazelisk-linux-amd64
30+
sudo mv bazelisk-linux-amd64 /usr/local/bin/bazel
31+
32+
- name: Build grpc_php_plugin and grpc_pyhon_plugin
33+
run: |
34+
bazel build src/compiler:grpc_php_plugin
35+
bazel build src/compiler:grpc_python_plugin
36+
- name: Archive artifacts
37+
env:
38+
VERSION: ${{ steps.get_release.outputs.tag_name }}
39+
run: |
40+
cd bazel-bin/src/compiler/
41+
cp grpc_php_plugin grpc-php-plugin
42+
tar czf grpc-php-plugin.${VERSION}.linux.amd64.tar.gz grpc-php-plugin
43+
cp grpc_python_plugin grpc-python-plugin
44+
tar czf grpc-python-plugin.${VERSION}.linux.amd64.tar.gz grpc-python-plugin
45+
46+
- name: Upload Release Asset for grpc_php_plugin
47+
uses: actions/upload-release-asset@v1
48+
env:
49+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
50+
with:
51+
upload_url: ${{ steps.get_release.outputs.upload_url }}
52+
asset_path: bazel-bin/src/compiler/grpc-php-plugin.${{ steps.get_release.outputs.tag_name }}.linux.amd64.tar.gz
53+
asset_name: grpc-php-plugin.${{ steps.get_release.outputs.tag_name }}.linux.amd64.tar.gz
54+
asset_content_type: application/gzip
55+
56+
- name: Upload Release Asset for grpc_python_plugin
57+
uses: actions/upload-release-asset@v1
58+
env:
59+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
60+
with:
61+
upload_url: ${{ steps.get_release.outputs.upload_url }}
62+
asset_path: bazel-bin/src/compiler/grpc-python-plugin.${{ steps.get_release.outputs.tag_name }}.linux.amd64.tar.gz
63+
asset_name: grpc-python-plugin.${{ steps.get_release.outputs.tag_name }}.linux.amd64.tar.gz
64+
asset_content_type: application/gzip
65+
66+
macos:
67+
name: macos@amd64
68+
runs-on: macos-latest
69+
70+
steps:
71+
- name: Get release
72+
id: get_release
73+
uses: bruceadams/[email protected]
74+
env:
75+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
76+
77+
- name: Checkout
78+
uses: actions/checkout@v2
79+
with:
80+
repository: grpc/grpc
81+
ref: ${{ steps.get_release.outputs.tag_name }}
82+
83+
- name: Install Basilisk
84+
run: |
85+
wget https://github.com/bazelbuild/bazelisk/releases/download/v1.7.5/bazelisk-darwin-amd64
86+
chmod a+x bazelisk-darwin-amd64
87+
sudo mv bazelisk-darwin-amd64 /usr/local/bin/bazel
88+
89+
- name: Build grpc_php_plugin and grpc_python_plugin
90+
run: |
91+
bazel build src/compiler:grpc_php_plugin
92+
bazel build src/compiler:grpc_python_plugin
93+
- name: Archive artifacts
94+
env:
95+
VERSION: ${{ steps.get_release.outputs.tag_name }}
96+
run: |
97+
cd bazel-bin/src/compiler/
98+
cp grpc_php_plugin grpc-php-plugin
99+
tar czf grpc-php-plugin.${VERSION}.darwin.amd64.tar.gz grpc-php-plugin
100+
cp grpc_python_plugin grpc-python-plugin
101+
tar czf grpc-python-plugin.${VERSION}.darwin.amd64.tar.gz grpc-python-plugin
102+
103+
- name: Upload Release Asset for grpc_php_plugin
104+
uses: actions/upload-release-asset@v1
105+
env:
106+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
107+
with:
108+
upload_url: ${{ steps.get_release.outputs.upload_url }}
109+
asset_path: bazel-bin/src/compiler/grpc-php-plugin.${{ steps.get_release.outputs.tag_name }}.darwin.amd64.tar.gz
110+
asset_name: grpc-php-plugin.${{ steps.get_release.outputs.tag_name }}.darwin.amd64.tar.gz
111+
asset_content_type: application/gzip
112+
113+
- name: Upload Release Asset for grpc_python_plugin
114+
uses: actions/upload-release-asset@v1
115+
env:
116+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
117+
with:
118+
upload_url: ${{ steps.get_release.outputs.upload_url }}
119+
asset_path: bazel-bin/src/compiler/grpc-python-plugin.${{ steps.get_release.outputs.tag_name }}.darwin.amd64.tar.gz
120+
asset_name: grpc-python-plugin.${{ steps.get_release.outputs.tag_name }}.darwin.amd64.tar.gz
121+
asset_content_type: application/gzip

LICENSE

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

README.md

Lines changed: 40 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,40 @@
1-
# grpc-protoc-plugins
2-
Pipeline and releases for gRPC PHP and Pythin plugins that are not available as prebuilt artifacts
1+
# grpc-php-plugin && grpc-python-plugin
2+
3+
At the time of this repo creation [the official way][1] of getting `grpc-php-plugin` artifact was to build it manually:
4+
5+
> It should already been compiled when you run `make` from the root directory of this repo.
6+
> The plugin can be found in the `bins/opt` directory.
7+
> _We are planning to provide a better way to download and install the plugin in the future._
8+
9+
Python gRPC plugin is not provided as standalone `protoc` plugin as well
10+
with the [recommendation to use python module][6]:
11+
12+
> `python -m pip install grpcio-tools`
13+
> `$ python -m grpc_tools.protoc -I../../protos --python_out=. --grpc_python_out=. ../../protos/helloworld.proto`
14+
15+
This repository is a temporary solution for building and storing `grpc-php-plugin` and `grpc-python-plugin` artifacts
16+
to use as `protoc` plugins, until a better way will be found.
17+
18+
## How it works
19+
20+
Repo is not storing any [grpc code][2] but GitHub Actions pipeline and prebuilt artifacts in releases.
21+
22+
The flow is the following:
23+
- as soon as we need the fresh version of the plugins we create a release with the same version
24+
as [gRPC library release/tag][3] (e.g. `v1.35.0`)
25+
- GitHub Actions pipeline checks out the code of the library with corresponding version, builds artifacts
26+
(should be two per plugin - for `linux@amd64` and `darwin@amd64`) and attaches them to the release
27+
- projects/tools interested in the prebuilt artifacts can download and use them as they would normally do
28+
with other plugins (e.g. [grpc-go][4] already provides prebuilt artifacts)
29+
30+
## License
31+
32+
The content of this repository is licensed under [Apache License 2.0][5].
33+
All the derived works are licensed under their own licenses.
34+
35+
[1]: https://grpc.io/docs/languages/php/quickstart/#php-protoc-plugin
36+
[2]: https://github.com/grpc/grpc
37+
[3]: https://github.com/grpc/grpc/releases
38+
[4]: https://github.com/grpc/grpc-go/releases
39+
[5]: https://github.com/hellofresh/grpc-php-plugin/blob/master/LICENSE
40+
[6]: https://grpc.io/docs/languages/python/quickstart/#grpc-tools

0 commit comments

Comments
 (0)