diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..812f4d2 --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,34 @@ +# Copyright 2019 Google LLC +# +# 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 +# +# https://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. + +# Copied from https://github.com/firebase/extensions/blob/next/.github/workflows/release.yml + +name: Release + +on: + push: + branches: + - master + +jobs: + release: + name: "Create Releases" + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - name: Release Script + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + run: | + ./.github/workflows/scripts/release.sh diff --git a/.github/workflows/scripts/release.sh b/.github/workflows/scripts/release.sh new file mode 100755 index 0000000..0e1d86e --- /dev/null +++ b/.github/workflows/scripts/release.sh @@ -0,0 +1,202 @@ +# Copyright 2019 Google LLC +# +# 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 +# +# https://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. + +# Copied and modified from https://github.com/firebase/extensions/blob/next/.github/workflows/scripts/release.sh. Changes: +# 1. Read the extension name from the extension.yaml file instead of from the directory name. + +#!/bin/bash +set -e +set -o pipefail + +# Uncomment for testing purposes: + +#GITHUB_TOKEN=YOUR_TOKEN_HERE +#GITHUB_REPOSITORY=invertase/extensions-release-testing + +# ------------------- +# Functions +# ------------------- +json_escape() { + printf '%s' "$1" | python -c 'import json,sys; print(json.dumps(sys.stdin.read()))' +} + +# Creates a new GitHub release +# ARGS: +# 1: Name of the release (becomes the release title on GitHub) +# 2: Markdown body of the release +# 3: Release Git tag +create_github_release() { + local response='' + local release_name=$1 + local release_body=$2 + local release_tag=$3 + + local body='{ + "tag_name": "%s", + "target_commitish": "master", + "name": "%s", + "body": %s, + "draft": false, + "prerelease": false + }' + + # shellcheck disable=SC2059 + body=$(printf "$body" "$release_tag" "$release_name" "$release_body") + response=$(curl --request POST \ + --url https://api.github.com/repos/${GITHUB_REPOSITORY}/releases \ + --header "Authorization: Bearer $GITHUB_TOKEN" \ + --header 'Content-Type: application/json' \ + --data "$body" \ + -s) + + created=$(echo "$response" | python -c "import sys, json; data = json.load(sys.stdin); print(data.get('id', sys.stdin))") + if [ "$created" != "$response" ]; then + printf "release created successfully!\n" + else + printf "release failed to create; " + printf "\n%s\n" "$body" + printf "\n%s\n" "$response" + exit 1 + fi +} + +# Updates an existing GitHub release +# ARGS: +# 1: Name of the release (becomes the release title on GitHub) +# 2: Markdown body of the release +# 3: Release Git tag +# 4: ID of the existing release +update_github_release() { + local response='' + local release_name=$1 + local release_body=$2 + local release_tag=$3 + local release_id=$4 + + local body='{ + "tag_name": "%s", + "target_commitish": "master", + "name": "%s", + "body": %s, + "draft": false, + "prerelease": false + }' + + # shellcheck disable=SC2059 + body=$(printf "$body" "$release_tag" "$release_name" "$release_body") + response=$(curl --request PATCH \ + --url "https://api.github.com/repos/$GITHUB_REPOSITORY/releases/$release_id" \ + --header "Authorization: Bearer $GITHUB_TOKEN" \ + --header 'Content-Type: application/json' \ + --data "$body" \ + -s) + + updated=$(echo "$response" | python -c "import sys, json; data = json.load(sys.stdin); print(data.get('id', sys.stdin))") + if [ "$updated" != "$response" ]; then + printf "release updated successfully!\n" + else + printf "release failed to update; " + printf "\n%s\n" "$body" + printf "\n%s\n" "$response" + exit 1 + fi +} + +# Creates or updates a GitHub release +# ARGS: +# 1: Extension name +# 2: Extension version +# 3: Markdown body to use for the release +create_or_update_github_release() { + local response='' + local release_id='' + local extension_name=$1 + local extension_version=$2 + local release_body=$3 + local release_tag="$extension_name-v$extension_version" + local release_name="$extension_name v$extension_version" + + response=$(curl --request GET \ + --url "https://api.github.com/repos/${GITHUB_REPOSITORY}/releases/tags/${release_tag}" \ + --header "Authorization: Bearer $GITHUB_TOKEN" \ + --header 'Content-Type: application/json' \ + --data "$body" \ + -s) + + release_id=$(echo "$response" | python -c "import sys, json; data = json.load(sys.stdin); print(data.get('id', 'Not Found'))") + if [ "$release_id" != "Not Found" ]; then + existing_release_body=$(echo "$response" | python -c "import sys, json; data = json.load(sys.stdin); print(data.get('body', ''))") + existing_release_body=$(json_escape "$existing_release_body") + # Only update it if the release body is different (this can happen if a change log is manually updated) + printf "Existing release (%s) found for %s - " "$release_id" "$release_tag" + if [ "$existing_release_body" != "$release_body" ]; then + printf "updating it with updated release body ... " + update_github_release "$release_name" "$release_body" "$release_tag" "$release_id" + else + printf "skipping it as release body is already up to date.\n" + fi + else + response_message=$(echo "$response" | python -c "import sys, json; data = json.load(sys.stdin); print(data.get('message'))") + if [ "$response_message" != "Not Found" ]; then + echo "Failed to query release '$release_name' -> GitHub API request failed with response: $response_message" + echo "$response" + exit 1 + else + printf "Creating new release '%s' ... " "$release_tag" + create_github_release "$release_name" "$release_body" "$release_tag" + fi + fi +} + +# ------------------- +# Main Script +# ------------------- + +# Ensure that the GITHUB_TOKEN env variable is defined +if [[ -z "$GITHUB_TOKEN" ]]; then + echo "Missing required GITHUB_TOKEN env variable. Set this on the workflow action or on your local environment." + exit 1 +fi + +# Ensure that the GITHUB_REPOSITORY env variable is defined +if [[ -z "$GITHUB_REPOSITORY" ]]; then + echo "Missing required GITHUB_REPOSITORY env variable. Set this on the workflow action or on your local environment." + exit 1 +fi + +# Find all extensions based on whether a extension.yaml file exists in the directory +for i in $(find . -type f -name 'extension.yaml' -exec dirname {} \; | sort -u); do + # Pluck extension latest name from yaml file + extension_name=$(awk '/^name: /' "$i/extension.yaml" | sed "s/name: //") + # Pluck extension latest version from yaml file + extension_version=$(awk '/^version: /' "$i/extension.yaml" | sed "s/version: //") + + changelog_contents="No changelog found for this version." + + # Ensure changelog exists + if [ -f "$i/CHANGELOG.md" ]; then + # Pluck out change log contents for the latest extension version + changelog_contents=$(awk -v ver="$extension_version" '/^## Version / { if (p) { exit }; if ($3 == ver) { p=1; next} } p && NF' "$i/CHANGELOG.md") + else + echo "WARNING: A changelog could not be found at $i/CHANGELOG.md - a default entry will be used instead." + fi + + # JSON escape the markdown content for the release body + changelog_contents=$(json_escape "$changelog_contents") + + # Creates a new release if it does not exist + # OR + # Updates an existing release with updated content (allows updating CHANGELOG.md which will update relevant release body) + create_or_update_github_release "$extension_name" "$extension_version" "$changelog_contents" +done diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml new file mode 100644 index 0000000..e85adef --- /dev/null +++ b/.github/workflows/test.yml @@ -0,0 +1,47 @@ +# Copyright 2019 Google LLC +# +# 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 +# +# https://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. + +# Copied and modified from https://github.com/firebase/extensions/blob/next/.github/workflows/test.yml. Changes: +# 1. Changed node versions list to only 18. +# 2. Updated paths to use functions directory. + +name: Testing + +on: + push: + branches: + - "**" + pull_request: + branches: + - "**" + +jobs: + nodejs: + runs-on: ubuntu-latest + strategy: + matrix: + node: ["18"] + name: node.js_${{ matrix.node }}_test + steps: + - uses: actions/checkout@v3 + - name: Setup node + uses: actions/setup-node@v3 + with: + node-version: ${{ matrix.node }} + cache: "npm" + cache-dependency-path: "**/package-lock.json" + - name: npm install + run: cd functions && npm i + - name: npm test + run: cd functions && npm run test diff --git a/.github/workflows/validate.yml b/.github/workflows/validate.yml new file mode 100644 index 0000000..9dfec8b --- /dev/null +++ b/.github/workflows/validate.yml @@ -0,0 +1,40 @@ +# Copyright 2019 Google LLC +# +# 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 +# +# https://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. + +# Copied from https://github.com/firebase/extensions/blob/next/.github/workflows/validate.yml +# 1. Changed node versions list to only 18. +# 2. Updated paths to use functions directory. + +name: Validate + +on: + pull_request: + branches: + - "**" + +jobs: + formatting: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - name: Setup node + uses: actions/setup-node@v3 + with: + node-version: 18 + cache: "npm" + cache-dependency-path: "**/package-lock.json" + - name: npm install + run: cd functions && npm i + - name: Prettier Lint Check + run: cd functions && npm run lint \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index a85a39b..b6bd1e9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,7 @@ - Add a configurable retry to allow a higher chance of requests causing transient failures to succeed (PR #69) - Added linter config and updated packages. (PR #70) - Node.JS 18 runtime for functions (PR #73) +- GitHub Actions Support to assist with verification and publishing (PR #77) ## Version 0.5.3 diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..7a4a3ea --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + 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. \ No newline at end of file diff --git a/functions/index.js b/functions/index.js index 3ae50ff..8f64246 100644 --- a/functions/index.js +++ b/functions/index.js @@ -467,7 +467,7 @@ exports.memberEventsHandler = firestore.document(config.mailchimpMemberEventsWat getSubscriberEmail(prevDoc, newDoc, eventsConfig.subscriberEmail), ); - // Invoke mailchimp API with updated tags + // Invoke mailchimp API with new events if (memberEvents && memberEvents.length) { const requests = memberEvents.reduce((acc, name) => { acc.push(