Radish alpha
r
radicle-native-ci
rad:z3qg5TKmN83afz2fj9z3fQjU8vaYE
Radicle CI adapter for native CI
Radicle
Git
Commits › b38a6c4
docs: update README and add licenses
Lars Wirzenius committed 2 years ago
commit b38a6c4767082c35014cda496cd204ea289ce52a
parent 26396fa
3 files changed +248 -4
added LICENSE-APACHE
@@ -0,0 +1,176 @@
+ 
                              Apache License
+ 
                        Version 2.0, January 2004
+ 
                     http://www.apache.org/licenses/
+
+ 
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 
1. Definitions.
+
+ 
   "License" shall mean the terms and conditions for use, reproduction,
+ 
   and distribution as defined by Sections 1 through 9 of this document.
+
+ 
   "Licensor" shall mean the copyright owner or entity authorized by
+ 
   the copyright owner that is granting the License.
+
+ 
   "Legal Entity" shall mean the union of the acting entity and all
+ 
   other entities that control, are controlled by, or are under common
+ 
   control with that entity. For the purposes of this definition,
+ 
   "control" means (i) the power, direct or indirect, to cause the
+ 
   direction or management of such entity, whether by contract or
+ 
   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ 
   outstanding shares, or (iii) beneficial ownership of such entity.
+
+ 
   "You" (or "Your") shall mean an individual or Legal Entity
+ 
   exercising permissions granted by this License.
+
+ 
   "Source" form shall mean the preferred form for making modifications,
+ 
   including but not limited to software source code, documentation
+ 
   source, and configuration files.
+
+ 
   "Object" form shall mean any form resulting from mechanical
+ 
   transformation or translation of a Source form, including but
+ 
   not limited to compiled object code, generated documentation,
+ 
   and conversions to other media types.
+
+ 
   "Work" shall mean the work of authorship, whether in Source or
+ 
   Object form, made available under the License, as indicated by a
+ 
   copyright notice that is included in or attached to the work
+ 
   (an example is provided in the Appendix below).
+
+ 
   "Derivative Works" shall mean any work, whether in Source or Object
+ 
   form, that is based on (or derived from) the Work and for which the
+ 
   editorial revisions, annotations, elaborations, or other modifications
+ 
   represent, as a whole, an original work of authorship. For the purposes
+ 
   of this License, Derivative Works shall not include works that remain
+ 
   separable from, or merely link (or bind by name) to the interfaces of,
+ 
   the Work and Derivative Works thereof.
+
+ 
   "Contribution" shall mean any work of authorship, including
+ 
   the original version of the Work and any modifications or additions
+ 
   to that Work or Derivative Works thereof, that is intentionally
+ 
   submitted to Licensor for inclusion in the Work by the copyright owner
+ 
   or by an individual or Legal Entity authorized to submit on behalf of
+ 
   the copyright owner. For the purposes of this definition, "submitted"
+ 
   means any form of electronic, verbal, or written communication sent
+ 
   to the Licensor or its representatives, including but not limited to
+ 
   communication on electronic mailing lists, source code control systems,
+ 
   and issue tracking systems that are managed by, or on behalf of, the
+ 
   Licensor for the purpose of discussing and improving the Work, but
+ 
   excluding communication that is conspicuously marked or otherwise
+ 
   designated in writing by the copyright owner as "Not a Contribution."
+
+ 
   "Contributor" shall mean Licensor and any individual or Legal Entity
+ 
   on behalf of whom a Contribution has been received by Licensor and
+ 
   subsequently incorporated within the Work.
+
+ 
2. Grant of Copyright License. Subject to the terms and conditions of
+ 
   this License, each Contributor hereby grants to You a perpetual,
+ 
   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ 
   copyright license to reproduce, prepare Derivative Works of,
+ 
   publicly display, publicly perform, sublicense, and distribute the
+ 
   Work and such Derivative Works in Source or Object form.
+
+ 
3. Grant of Patent License. Subject to the terms and conditions of
+ 
   this License, each Contributor hereby grants to You a perpetual,
+ 
   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ 
   (except as stated in this section) patent license to make, have made,
+ 
   use, offer to sell, sell, import, and otherwise transfer the Work,
+ 
   where such license applies only to those patent claims licensable
+ 
   by such Contributor that are necessarily infringed by their
+ 
   Contribution(s) alone or by combination of their Contribution(s)
+ 
   with the Work to which such Contribution(s) was submitted. If You
+ 
   institute patent litigation against any entity (including a
+ 
   cross-claim or counterclaim in a lawsuit) alleging that the Work
+ 
   or a Contribution incorporated within the Work constitutes direct
+ 
   or contributory patent infringement, then any patent licenses
+ 
   granted to You under this License for that Work shall terminate
+ 
   as of the date such litigation is filed.
+
+ 
4. Redistribution. You may reproduce and distribute copies of the
+ 
   Work or Derivative Works thereof in any medium, with or without
+ 
   modifications, and in Source or Object form, provided that You
+ 
   meet the following conditions:
+
+ 
   (a) You must give any other recipients of the Work or
+ 
       Derivative Works a copy of this License; and
+
+ 
   (b) You must cause any modified files to carry prominent notices
+ 
       stating that You changed the files; and
+
+ 
   (c) You must retain, in the Source form of any Derivative Works
+ 
       that You distribute, all copyright, patent, trademark, and
+ 
       attribution notices from the Source form of the Work,
+ 
       excluding those notices that do not pertain to any part of
+ 
       the Derivative Works; and
+
+ 
   (d) If the Work includes a "NOTICE" text file as part of its
+ 
       distribution, then any Derivative Works that You distribute must
+ 
       include a readable copy of the attribution notices contained
+ 
       within such NOTICE file, excluding those notices that do not
+ 
       pertain to any part of the Derivative Works, in at least one
+ 
       of the following places: within a NOTICE text file distributed
+ 
       as part of the Derivative Works; within the Source form or
+ 
       documentation, if provided along with the Derivative Works; or,
+ 
       within a display generated by the Derivative Works, if and
+ 
       wherever such third-party notices normally appear. The contents
+ 
       of the NOTICE file are for informational purposes only and
+ 
       do not modify the License. You may add Your own attribution
+ 
       notices within Derivative Works that You distribute, alongside
+ 
       or as an addendum to the NOTICE text from the Work, provided
+ 
       that such additional attribution notices cannot be construed
+ 
       as modifying the License.
+
+ 
   You may add Your own copyright statement to Your modifications and
+ 
   may provide additional or different license terms and conditions
+ 
   for use, reproduction, or distribution of Your modifications, or
+ 
   for any such Derivative Works as a whole, provided Your use,
+ 
   reproduction, and distribution of the Work otherwise complies with
+ 
   the conditions stated in this License.
+
+ 
5. Submission of Contributions. Unless You explicitly state otherwise,
+ 
   any Contribution intentionally submitted for inclusion in the Work
+ 
   by You to the Licensor shall be under the terms and conditions of
+ 
   this License, without any additional terms or conditions.
+ 
   Notwithstanding the above, nothing herein shall supersede or modify
+ 
   the terms of any separate license agreement you may have executed
+ 
   with Licensor regarding such Contributions.
+
+ 
6. Trademarks. This License does not grant permission to use the trade
+ 
   names, trademarks, service marks, or product names of the Licensor,
+ 
   except as required for reasonable and customary use in describing the
+ 
   origin of the Work and reproducing the content of the NOTICE file.
+
+ 
7. Disclaimer of Warranty. Unless required by applicable law or
+ 
   agreed to in writing, Licensor provides the Work (and each
+ 
   Contributor provides its Contributions) on an "AS IS" BASIS,
+ 
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ 
   implied, including, without limitation, any warranties or conditions
+ 
   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ 
   PARTICULAR PURPOSE. You are solely responsible for determining the
+ 
   appropriateness of using or redistributing the Work and assume any
+ 
   risks associated with Your exercise of permissions under this License.
+
+ 
8. Limitation of Liability. In no event and under no legal theory,
+ 
   whether in tort (including negligence), contract, or otherwise,
+ 
   unless required by applicable law (such as deliberate and grossly
+ 
   negligent acts) or agreed to in writing, shall any Contributor be
+ 
   liable to You for damages, including any direct, indirect, special,
+ 
   incidental, or consequential damages of any character arising as a
+ 
   result of this License or out of the use or inability to use the
+ 
   Work (including but not limited to damages for loss of goodwill,
+ 
   work stoppage, computer failure or malfunction, or any and all
+ 
   other commercial damages or losses), even if such Contributor
+ 
   has been advised of the possibility of such damages.
+
+ 
9. Accepting Warranty or Additional Liability. While redistributing
+ 
   the Work or Derivative Works thereof, You may choose to offer,
+ 
   and charge a fee for, acceptance of support, warranty, indemnity,
+ 
   or other liability obligations and/or rights consistent with this
+ 
   License. However, in accepting such obligations, You may act only
+ 
   on Your own behalf and on Your sole responsibility, not on behalf
+ 
   of any other Contributor, and only if You agree to indemnify,
+ 
   defend, and hold each Contributor harmless for any liability
+ 
   incurred by, or claims asserted against, such Contributor by reason
+ 
   of your accepting any such warranty or additional liability.
+
+ 
END OF TERMS AND CONDITIONS
added LICENSE-MIT
@@ -0,0 +1,21 @@
+ 
MIT License
+
+ 
Copyright (c) 2021 The Radicle Foundation
+
+ 
Permission is hereby granted, free of charge, to any person obtaining a copy
+ 
of this software and associated documentation files (the "Software"), to deal
+ 
in the Software without restriction, including without limitation the rights
+ 
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ 
copies of the Software, and to permit persons to whom the Software is
+ 
furnished to do so, subject to the following conditions:
+
+ 
The above copyright notice and this permission notice shall be included in all
+ 
copies or substantial portions of the Software.
+
+ 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ 
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ 
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ 
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ 
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ 
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ 
SOFTWARE.
modified README.md
@@ -1,16 +1,63 @@
# radicle-native-ci
- 
This is an adapter for Radicle CI, for performing CI runs locally.
- 
It's meant to be used with, and executed by, `radicle-c-broker`.
+ 
This is an adapter for the [Radicle CI broker], for performing CI runs
+ 
locally.



The CI run is performed locally, without any isolation. This is not

safe and secure, but it's simple, and easy to get working. Do not use
- 
this unless you trust the repository.
+ 
this unless you trust the repository and its dependencies.
- 
The repository must contain a file `..radicle/native.yaml` that
+ 
The repository must contain a file `./radicle/native.yaml` that

specifies how CI is run for the repository. For example:



```yaml

shell: |

  cargo test --locked --workspace

```
+
+ 
 [Radicle CI broker]: https://app.radicle.xyz/nodes/radicle.liw.fi/rad:zwTxygwuz5LDGBq255RA2CbNGrz8
+
+ 
## Architecture
+
+ 
See the [documentation](doc) directory for an architecture document.
+
+ 
## Configuration
+
+ 
The adapter requires the `RADICLE_NATIVE_CI` environment variable to
+ 
be set to the filename of a configuration file in YAML. For example:
+
+ 
~~~yaml
+ 
state: /srv/http
+ 
log: /home/_rad/native-ci.log
+ 
~~~
+
+ 
The fields are:
+
+ 
* `state` --- required, directory where per-run directories are stored
+ 
* `log` --- required, file where native CI should write a log
+ 
* `timeout` --- optional, maximum duration of the run, in seconds
+
+
+ 
## Packaging
+
+ 
There is simple, simplistic, rudimentary, personal-use-only packaging
+ 
for Debian in the `debian` directory, used by Lars to build packages
+ 
for his own use.
+
+ 
## Running tests
+
+ 
To run the test suite for the CI broker:
+
+ 
~~~sh
+ 
cargo test
+ 
~~~
+
+ 
(The usual way, for a Rust program.)
+
+
+ 
## License
+
+ 
Radicle native CI is distributed under the terms of both the MIT
+ 
license and the Apache License (Version 2.0).
+
+ 
See [LICENSE-APACHE](LICENSE-APACHE) and [LICENSE-MIT](LICENSE-MIT) for details.