{"id":20508557,"url":"https://github.com/novuhq/actions-novu-sync","last_synced_at":"2025-03-05T22:19:20.637Z","repository":{"id":225669010,"uuid":"766548201","full_name":"novuhq/actions-novu-sync","owner":"novuhq","description":"Sync your state with Novu Cloud.","archived":false,"fork":false,"pushed_at":"2024-07-02T10:23:14.000Z","size":241,"stargazers_count":1,"open_issues_count":3,"forks_count":1,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-02-25T16:42:24.739Z","etag":null,"topics":["code-first","notifications","novu"],"latest_commit_sha":null,"homepage":"https://novu.co","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/novuhq.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-03-03T15:15:16.000Z","updated_at":"2024-11-01T13:57:07.000Z","dependencies_parsed_at":"2024-06-12T14:04:13.626Z","dependency_job_id":"95a4dfa2-f446-4ade-b8b9-2a5867ca0a29","html_url":"https://github.com/novuhq/actions-novu-sync","commit_stats":null,"previous_names":["novuhq/actions-echo-sync","novuhq/actions-novu-sync"],"tags_count":8,"template":false,"template_full_name":"actions/typescript-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/novuhq%2Factions-novu-sync","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/novuhq%2Factions-novu-sync/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/novuhq%2Factions-novu-sync/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/novuhq%2Factions-novu-sync/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/novuhq","download_url":"https://codeload.github.com/novuhq/actions-novu-sync/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242111577,"owners_count":20073453,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["code-first","notifications","novu"],"created_at":"2024-11-15T20:19:14.150Z","updated_at":"2025-03-05T22:19:20.600Z","avatar_url":"https://github.com/novuhq.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Novu Sync Action V2\n\n![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/novuhq/actions-novu-sync/ci.yml)\n\nThis action syncs your state with Novu Cloud.\n\n## What's new\n\nPlease refer to the [release page](https://github.com/novuhq/actions-novu-sync/releases/latest)\nfor the latest release notes.\n\n## Usage\n\n```yaml\n- uses: novuhq/actions-novu-sync@v2\n  with:\n    # The secret key used to authenticate with Novu Cloud\n    # To get the secret key, go to https://web.novu.co/api-keys.\n    # Required.\n    secret-key: ${{ secrets.NOVU_SECRET_KEY }}\n\n    # The publicly available endpoint hosting the bridge application\n    # where notification entities (eg. workflows, topics) are defined.\n    # Required.\n    bridge-url: ${{ secrets.NOVU_BRIDGE_URL }}\n\n    # The Novu Cloud API URL to sync with.\n    # Optional.\n    # Defaults to https://api.novu.co\n    api-url: https://api.novu.co\n```\n\n### Sync with Novu Cloud\n\n```yaml\n- uses: novuhq/actions-novu-sync@v2\n  with:\n    secret-key: ${{ secrets.NOVU_SECRET_KEY }}\n    bridge-url: ${{ secrets.NOVU_BRIDGE_URL }}\n```\n\n### Sync with Novu Cloud EU region\n\n```yaml\n- uses: novuhq/actions-novu-sync@v2\n  with:\n    secret-key: ${{ secrets.NOVU_SECRET_KEY }}\n    bridge-url: ${{ secrets.NOVU_BRIDGE_URL }}\n    api-url: https://eu.api.novu.co\n```\n\n## Outputs\n\nThe command exposes 2 outputs:\n\n1. `success`: a boolean flag indicating the success status of the action execution\n1. `result`: the response data sent from Novu Cloud after the sync request\n\n## Developing the action further\n\n1. 🔨 Install the dependencies\n\n   ```bash\n   npm install\n   ```\n\n1. 🏗️ Lint, test and package the TypeScript for distribution\n\n   ```bash\n   npm run all\n   ```\n\n## Publishing a New Release\n\nThis project includes a helper script, [`script/release`](./script/release)\ndesigned to streamline the process of tagging and pushing new releases for\nGitHub Actions.\n\nGitHub Actions allows users to select a specific version of the action to use,\nbased on release tags. This script simplifies this process by performing the\nfollowing steps:\n\n1. **Retrieving the latest release tag:** The script starts by fetching the most\n   recent release tag by looking at the local data available in your repository.\n1. **Prompting for a new release tag:** The user is then prompted to enter a new\n   release tag. To assist with this, the script displays the latest release tag\n   and provides a regular expression to validate the format of the new tag.\n1. **Tagging the new release:** Once a valid new tag is entered, the script tags\n   the new release.\n1. **Pushing the new tag to the remote:** Finally, the script pushes the new tag\n   to the remote repository. From here, you will need to create a new release in\n   GitHub and users can easily reference the new tag in their workflows.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnovuhq%2Factions-novu-sync","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnovuhq%2Factions-novu-sync","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnovuhq%2Factions-novu-sync/lists"}