From acbe3c29f107b8b7227658a7daecb939c6636002 Mon Sep 17 00:00:00 2001 From: Nicholas Date: Tue, 26 Mar 2024 22:15:10 +0000 Subject: [PATCH] fix: rename, whoops --- .github/CONTRIBUTING.md | 8 ++++---- .github/ISSUE_TEMPLATE/bug-report.yml | 10 +++++----- .github/ISSUE_TEMPLATE/config.yml | 2 +- .github/workflows/cla.yml | 2 +- README.md | 20 ++++++++++---------- package.json | 8 ++++---- 6 files changed, 25 insertions(+), 25 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 963f202..252bfae 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,8 +1,8 @@ # Contributing -Thank you for your interest in contributing to the cloudflare-queue-producer. +Thank you for your interest in contributing to the cloudflare-queue-consumer. -- If you're unsure if a feature would make a good addition, you can always [create an issue](https://github.com/bbc/cloudflare-queue-producer/issues/new) first. Raising an issue before creating a pull request is recommended. +- If you're unsure if a feature would make a good addition, you can always [create an issue](https://github.com/bbc/cloudflare-queue-consumer/issues/new) first. Raising an issue before creating a pull request is recommended. - We aim for 100% test coverage. Please write tests for any new functionality or changes. - Any API changes should be fully documented. - Make sure your code meets our linting standards. Run `npm run lint` to check your code. @@ -11,7 +11,7 @@ Thank you for your interest in contributing to the cloudflare-queue-producer. ## Reporting Issues -Before opening a new issue, first check that there is not already an [open issue or Pull Request](https://github.com/bbc/cloudflare-queue-producer/issues?utf8=%E2%9C%93&q=is%3Aopen) that addresses it. +Before opening a new issue, first check that there is not already an [open issue or Pull Request](https://github.com/bbc/cloudflare-queue-consumer/issues?utf8=%E2%9C%93&q=is%3Aopen) that addresses it. If there is, make relevant comments and add your reaction. Use a reaction in place of a "+1" comment: @@ -20,7 +20,7 @@ If there is, make relevant comments and add your reaction. Use a reaction in pla If you cannot find an existing issue that describes your bug or feature, create a new issue using the guidelines below. -1. Pick an appropriate template for the type of issue [from here](https://github.com/bbc/cloudflare-queue-producer/issues/choose) +1. Pick an appropriate template for the type of issue [from here](https://github.com/bbc/cloudflare-queue-consumer/issues/choose) 2. Provide as much detail as possible 3. Follow your issue in the issue tracking workflow diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 5ac2638..e7dab89 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -8,13 +8,13 @@ body: value: | Thank you for reporting an issue! - This issue tracker is for reporting reproducible bugs or regression's found in this package, if you have a question or feature request, please report it within the [Discussions tab](https://github.com/bbc/cloudflare-queue-producer/discussions) instead. + This issue tracker is for reporting reproducible bugs or regression's found in this package, if you have a question or feature request, please report it within the [Discussions tab](https://github.com/bbc/cloudflare-queue-consumer/discussions) instead. Before submitting a new bug/issue, please check the links below to see if there is a solution or question posted there already: - - [Discussions](https://github.com/bbc/cloudflare-queue-producer/discussions) - - [Open Issues](https://github.com/bbc/cloudflare-queue-producer/issues?q=is%3Aopen+is%3Aissue) - - [Closed Issues](https://github.com/bbc/cloudflare-queue-producer/issues?q=is%3Aissue+is%3Aclosed) + - [Discussions](https://github.com/bbc/cloudflare-queue-consumer/discussions) + - [Open Issues](https://github.com/bbc/cloudflare-queue-consumer/issues?q=is%3Aopen+is%3Aissue) + - [Closed Issues](https://github.com/bbc/cloudflare-queue-consumer/issues?q=is%3Aissue+is%3Aclosed) The more information you fill in, the better the community can help you. - type: textarea @@ -32,7 +32,7 @@ body: Please add a link to a minimal reproduction. Note: - Please keep your example as simple and reproduceable as possible, try leaving out dependencies that are not required for reproduction. - - To create a shareable code example for web, you can use Stackblitz (https://stackblitz.com/edit/cloudflare-queue-producer-starter). + - To create a shareable code example for web, you can use Stackblitz (https://stackblitz.com/edit/cloudflare-queue-consumer-starter). - Please make sure the example is complete and runnable - e.g. avoid localhost URLs. placeholder: | e.g. Code Sandbox, Stackblitz, Expo Snack or TypeScript playground diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index e014dec..72487d6 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,5 +1,5 @@ blank_issues_enabled: false contact_links: - name: Feature Requests & Questions - url: https://github.com/bbc/cloudflare-queue-producer/discussions + url: https://github.com/bbc/cloudflare-queue-consumer/discussions about: Please ask and answer questions here. \ No newline at end of file diff --git a/.github/workflows/cla.yml b/.github/workflows/cla.yml index cc8b909..24ae8d7 100644 --- a/.github/workflows/cla.yml +++ b/.github/workflows/cla.yml @@ -21,7 +21,7 @@ jobs: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} PERSONAL_ACCESS_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }} with: - path-to-signatures: 'cloudflare-queue-producer/v1/cla.json' + path-to-signatures: 'cloudflare-queue-consumer/v1/cla.json' remote-organization-name: 'bbc' remote-repository-name: 'cla-signatures' path-to-document: 'https://bbc.github.io/cla-signatures/cla/v1/cla.html' diff --git a/README.md b/README.md index 6fad104..c64369a 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ -# cloudflare-queue-producer +# cloudflare-queue-consumer -[![NPM downloads](https://img.shields.io/npm/dm/@bbc/cloudflare-queue-producer.svg?style=flat)](https://npmjs.org/package/@bbc/cloudflare-queue-producer) -[![Build Status](https://github.com/bbc/cloudflare-queue-producer/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/bbc/cloudflare-queue-producer/actions/workflows/test.yml) -[![Maintainability](https://api.codeclimate.com/v1/badges/16ec3f59e73bc898b7ff/maintainability)](https://codeclimate.com/github/bbc/cloudflare-queue-producer/maintainability) -[![Test Coverage](https://api.codeclimate.com/v1/badges/16ec3f59e73bc898b7ff/test_coverage)](https://codeclimate.com/github/bbc/cloudflare-queue-producer/test_coverage) +[![NPM downloads](https://img.shields.io/npm/dm/@bbc/cloudflare-queue-consumer.svg?style=flat)](https://npmjs.org/package/@bbc/cloudflare-queue-consumer) +[![Build Status](https://github.com/bbc/cloudflare-queue-consumer/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/bbc/cloudflare-queue-consumer/actions/workflows/test.yml) +[![Maintainability](https://api.codeclimate.com/v1/badges/16ec3f59e73bc898b7ff/maintainability)](https://codeclimate.com/github/bbc/cloudflare-queue-consumer/maintainability) +[![Test Coverage](https://api.codeclimate.com/v1/badges/16ec3f59e73bc898b7ff/test_coverage)](https://codeclimate.com/github/bbc/cloudflare-queue-consumer/test_coverage) Build CloudFlare Queues applications without the boilerplate. Just define an async function that handles the message processing. @@ -16,17 +16,17 @@ Based on [sqs-consumer](https://github.com/bbc/sqs-consumer). To install this package, simply enter the following command into your terminal (or the variant of whatever package manager you are using): ```bash -npm install @bbc/cloudflare-queue-producer +npm install @bbc/cloudflare-queue-consumer ``` ## Documentation -Visit [https://bbc.github.io/cloudflare-queue-producer/](https://bbc.github.io/cloudflare-queue-producer/) for the full API documentation. +Visit [https://bbc.github.io/cloudflare-queue-consumer/](https://bbc.github.io/cloudflare-queue-consumer/) for the full API documentation. ## Usage ```js -import { Consumer } from "cloudflare-queue-producer"; +import { Consumer } from "cloudflare-queue-consumer"; // TODO: Add example ``` @@ -41,8 +41,8 @@ TODO: Add more information We welcome and appreciate contributions for anyone who would like to take the time to fix a bug or implement a new feature. -But before you get started, [please read the contributing guidelines](https://github.com/bbc/cloudflare-queue-producer/blob/main/.github/CONTRIBUTING.md) and [code of conduct](https://github.com/bbc/cloudflare-queue-producer/blob/main/.github/CODE_OF_CONDUCT.md). +But before you get started, [please read the contributing guidelines](https://github.com/bbc/cloudflare-queue-consumer/blob/main/.github/CONTRIBUTING.md) and [code of conduct](https://github.com/bbc/cloudflare-queue-consumer/blob/main/.github/CODE_OF_CONDUCT.md). ## License -CloudFlare Queue Consumer is distributed under the Apache License, Version 2.0, see [LICENSE](https://github.com/bbc/cloudflare-queue-producer/blob/main/LICENSE) for more information. +CloudFlare Queue Consumer is distributed under the Apache License, Version 2.0, see [LICENSE](https://github.com/bbc/cloudflare-queue-consumer/blob/main/LICENSE) for more information. diff --git a/package.json b/package.json index fb170a2..c61a12c 100644 --- a/package.json +++ b/package.json @@ -1,15 +1,15 @@ { - "name": "@bbc/cloudflare-queue-producer", + "name": "@bbc/cloudflare-queue-consumer", "version": "0.0.0", "description": "Build CloudFlare Queue applications without the boilerplate", "repository": { "type": "git", - "url": "git+https://github.com/bbc/cloudflare-queue-producer.git" + "url": "git+https://github.com/bbc/cloudflare-queue-consumer.git" }, "bugs": { - "url": "https://github.com/bbc/cloudflare-queue-producer/issues" + "url": "https://github.com/bbc/cloudflare-queue-consumer/issues" }, - "homepage": "https://bbc.github.io/cloudflare-queue-producer/", + "homepage": "https://bbc.github.io/cloudflare-queue-consumer/", "keywords": [ "sqs", "queue",