{"id":18974773,"url":"https://github.com/bigbite/release-notes","last_synced_at":"2025-06-19T11:35:57.955Z","repository":{"id":238706514,"uuid":"602531519","full_name":"bigbite/release-notes","owner":"bigbite","description":null,"archived":false,"fork":false,"pushed_at":"2025-04-11T09:23:30.000Z","size":1453,"stargazers_count":0,"open_issues_count":13,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-26T05:13:42.889Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bigbite.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-02-16T12:11:51.000Z","updated_at":"2025-04-11T09:22:19.000Z","dependencies_parsed_at":"2025-02-03T15:21:47.961Z","dependency_job_id":"5556622e-d82c-4e45-8fbc-6c67de3c0425","html_url":"https://github.com/bigbite/release-notes","commit_stats":null,"previous_names":["bigbite/release-notes"],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/bigbite/release-notes","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigbite%2Frelease-notes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigbite%2Frelease-notes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigbite%2Frelease-notes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigbite%2Frelease-notes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bigbite","download_url":"https://codeload.github.com/bigbite/release-notes/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigbite%2Frelease-notes/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260743166,"owners_count":23055908,"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":[],"created_at":"2024-11-08T15:16:14.485Z","updated_at":"2025-06-19T11:35:52.944Z","avatar_url":"https://github.com/bigbite.png","language":"PHP","readme":"# release-notes\n\n## Slack integration setup\n1. Create a slack app \u0026 webhook if you don't have one already (Follow steps 1 to 3 at https://api.slack.com/messaging/webhooks)\n2. Add the webhook to the sites settings page (wp-admin -\u003e settings -\u003e Release Notes)\n\n## Integrating with github releases\nIf you want to create a draft release note post using the notes you've added to the github release, you can do this automatically using the `bigbite/project` circleCI orb version `0.0.63` or newer. You just need to add the following to your .circleci/config.yml` file:\n```yaml\nworkflows:\n  release-workflow:\n    jobs:\n      - project/set-release-notes:\n          context: bigbite\n          filters:\n            branches:\n              ignore: /.*/\n            tags:\n              only: /^[0-9]+\\.[0-9]+\\.[0-9]+(\\-[\\w\\d\\.]+)?$/\n```\n\n## Creating a draft release remotely\nIf you want to create a draft release remotely, you can use the REST endpoint `POST /release-notes/v1/new-release` with the following parameters:\n- body: string - a git-markdown string used for the content of the release note post\n- isDraft: boolean - used to check if the release is just a draft, if it is true, the release note post will not be created\n- name: string - the name of the release\n- publishedAt: UTC date-time string - used to set the release date of the release note post\n- tagName: string - the release version\n- isPrerelease: boolean - used to note if a release is a pre-release or not\n\n## Installing\nWhen installing to your site, add the following to you `composer.json` file. This will ensure that installation will use the build version of the package and allow it to be loaded using composer in the preferred path.\n```json\n{\n  \"repositories\": [\n    {\n      \"type\": \"vcs\",\n      \"url\": \"git@github.com:bigbite/release-notes.git\"\n    }\n  ],\n  \"require\": {\n    \"bigbite/release-notes\": \"1.0.0-rc.6\"\n  },\n  \"extra\": {\n    \"installer-paths\": {\n      \"plugins/{$name}/\": [\n        \"type:wordpress-plugin\"\n      ]\n    }\n  }\n}\n\n```\n\n## Local Development or Manual Install\nClone the repository into your `plugins` or `client-mu-plugins` directory.\n```\ngit clone git@github.com:bigbite/release-notes.git \u0026\u0026 cd release-notes\n```\n\nInstall JS packages.\n```\nnpm install\n```\n\nBuild all assets - additional commands can be found on the [`bigbite/build-tools` repo.](https://github.com/bigbite/build-tools#commands)\n```\nnpm run build:dev\n```\n\nInstall PHP packages and create autoloader for the plugin.\n```\ncomposer update\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbigbite%2Frelease-notes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbigbite%2Frelease-notes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbigbite%2Frelease-notes/lists"}