diff --git a/LICENSE b/LICENSE index e06d208..fd032cf 100644 --- a/LICENSE +++ b/LICENSE @@ -1,202 +1,21 @@ -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 - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "{}" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright {yyyy} {name of copyright owner} - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - +MIT License + +Copyright (c) 2017 Rockefeller Archive Center + +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. diff --git a/README.md b/README.md index 0048ab8..5431fd9 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # docs-build -A Python WSGI application to handle GitHub webhooks for internal and external facing documentation websites. Based on [Python Github Webhooks](https://github.com/carlos-jenkins/python-github-webhooks) developed by [@carlos-jenkins](https://github.com/carlos-jenkins/) +A Python script which retrieves updates for documentation repositories and themes, and builds internal and external-facing sites. It can be set to run at a specified time (for example on a nightly basis) using cron. ## Install @@ -16,10 +16,6 @@ You can configure what the application does by copying the sample config file `config.json.sample` to `config.json` and adapting it to your needs: { - "github_ips_only": true, - "enforce_secret": "", - "return_scripts_info": true - "hooks_path": "/.../hooks/" "repository_dir": "/repositories", "site_root_dir": "/docs", "public_site_dir": "public", @@ -28,15 +24,6 @@ You can configure what the application does by copying the sample config file "build_dir": "build" } -`github_ips_only`: Restrict application to be called only by GitHub IPs. IPs whitelist is obtained from - [GitHub Meta](https://developer.github.com/v3/meta/) ([endpoint](https://api.github.com/meta)). Default: `true`. - -`enforce_secret`: Enforce body signature with HTTP header `X-Hub-Signature`. See `secret` at [GitHub WebHooks Documentation](https://developer.github.com/v3/repos/hooks/). Default: `''` (do not enforce). - - `return_scripts_info`: Return a JSON with the `stdout`, `stderr` and exit code for each executed hook using the hook name as key. If this option is set you will be able to see the result of your hooks from within your GitHub hooks configuration page (see "Recent Deliveries"). Default: `true`. - - `hooks_path`: Configures a path to import the hooks. If not set, it'll import the hooks from the default location (/.../docs-build/hooks) - `repository_dir`: Sets base directory into which repositories will be pulled from Github. See below for details `site_root_dir`: Configures the root directory for the site. @@ -49,26 +36,41 @@ You can configure what the application does by copying the sample config file `build_dir`: Configures the directory into which the final sites will be built, which will be nested below both `public_site_dir` and `private_site_dir` -## Build Hook +## Build Script -`build_sites.py` is the script that actually builds the sites. At a very high level, this hook parses an incoming webhook payload, pulls the updated data from GitHub, and then rebuilds the site using Jekyll. This script handles build processes for documentation and theme repositories differently. +`update.py` is the script that pulls the updated data from GitHub, and then rebuilds the site using Jekyll. It handles build processes for documentation and theme repositories differently. #### YAML Configuration In order to work correctly, `build_sites.py` expects that the following variables will be available in a file named `_config.yml` located the root directory of a documentation or theme repository. public: true - type: docs + type: "docs" + tags: + - "processing" + - "planning" + - "project vitals" + slug: "processing_manual" + title: "Guide to Processing Collections at the RAC" + description: "A manual for arranging and describing archival collections." `public` indicates whether or not the documentation should be public. Values should be either `true` or `false` (booleans, not strings). `type` tells the application whether the repository is a documentation or theme repository, which helps it determine how to handle the build process. +`tags` are a list of tags you wish to associate with the documentation. + +`slug` is a short reference to the repository. This should exactly match the name of the repository and should not include any spaces or slashes. + +`title` is the official title of the documentation, which will be displayed on the home page of the site. + +`description` is a short description of what the documentation is, the audience it is intended for, and what it helps that audience do. This text will be displayed on the home page of the site. + Other variables can be included in this config file if desired. #### Repository Structure -The application will create a directory (configured `config.json` as described above) containing subdirectories (based on repository name) for each repository in which a webhook is configured. Based on the default values supplied in `config.json.sample` that structure would be: +The application will create a directory (configured in `config.json` as described above) containing subdirectories (based on repository name) for each repository in which a webhook is configured. Based on the default values supplied in `config.json.sample` that structure would be: /repositories/ ∟my-docs-theme/ @@ -82,7 +84,7 @@ The application will create a directory (configured `config.json` as described a The build process copies directories and files from the repository directory to a new structure before executing the Jekyll build structure. -Assuming the values in `config.json.sample`, the final structure would be: +Assuming the values in `config.json.sample` above, the final structure would be: /var/www/ ∟public/ @@ -110,115 +112,6 @@ Assuming the values in `config.json.sample`, the final structure would be: The `site_build_directory` for the public and private sites contain the final sites that need to be served up via Apache or some other method. -## Adding Hooks - -It is possible to add additional webhooks by creating additional scripts in the hooks directory as configured above. Scripts will be executed in the following order: - - hooks/{event}-{name}-{branch} - hooks/{event}-{name} - hooks/{event} - hooks/all - -The application will pass to the hooks the path to a JSON file holding the payload for the request as first argument. The event type will be passed as the second argument. For example: - - hooks/push-myrepo-master /tmp/sXFHji push - -Hooks can be written in any scripting language as long as the file is executable and has a shebang. A simple example in Python could be: - - #!/usr/bin/env python - # Python Example for Python GitHub Webhooks - # File: push-myrepo-master - - import sys - import json - - with open(sys.argv[1], 'r') as jsf: - payload = json.loads(jsf.read()) - - ### Do something with the payload - name = payload['repository']['name'] - outfile = '/tmp/hook-{}.log'.format(name) - - with open(outfile, 'w') as f: - f.write(json.dumps(payload)) - -Not all events have an associated branch, so a branch-specific hook cannot fire for such events. For events that contain a pull_request object, the base branch (target for the pull request) is used, not the head branch. - -The payload structure depends on the event type. Please review [GitHub documentation on payload structure](https://developer.github.com/v3/activity/events/types/). - -## Deploy - -### Apache - -To deploy in Apache, just add a ``WSGIScriptAlias`` directive to your -VirtualHost file: - - - ServerAdmin you@my.site.com - ServerName my.site.com - DocumentRoot /var/www/site.com/my/htdocs/ - - # Handle Github webhook - - Order deny,allow - Allow from all - - WSGIScriptAlias /webhooks /var/www/site.com/my/python-github-webhooks/webhooks.py - - - -You can now [register the hook](https://developer.github.com/webhooks/creating/#setting-up-a-webhook) in your Github repository settings. Make sure you select Content type: `application/json` and set the URL to the URL -of your WSGI script. For example, using the Apache deployment above it would be: - - http://my.site.com/webhooks - - -## Test your deployment - -To test your hook you can use the [GitHub REST API](https://developer.github.com/v3/) with `curl`: - - curl --user "" https://api.github.com/repos///hooks - -Take note of the test_url. - - curl --user "" -i -X POST - -You should be able to see any log error in your webapp. - - -## Debug - -When running in Apache, the `stderr` of the hooks that return non-zero will be logged in Apache's error logs. For example: - - sudo tail -f /var/log/apache2/error.log - -Will log errors in your scripts if printed to `stderr`. - -You can also launch the Flask web server in debug mode at port `5000`. - - python webhooks.py - -This can help debug problem with the WSGI application itself. - - ## License - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. - -## Credits - -Based on Based on [Python Github Webhooks](https://github.com/carlos-jenkins/python-github-webhooks) developed by [@carlos-jenkins](https://github.com/carlos-jenkins/), which is a reinterpretation and merge of: - -- [github-webhook-wrapper](https://github.com/datafolklabs/github-webhook-wrapper) -- [flask-github-webhook](https://github.com/razius/flask-github-webhook) +This code is released under an [MIT License](LICENSE)