From 3f4a93fa65d6368963b8e4f818c3d3997078b2eb Mon Sep 17 00:00:00 2001 From: Mark Addis <35331926+nitro-marky@users.noreply.github.com> Date: Fri, 25 Nov 2022 14:57:45 +0000 Subject: [PATCH 1/3] First renaming --- CODE_OF_CONDUCT.md | 2 +- CONTRIBUTING.md | 34 +++++++++++++++++----------------- README.md | 10 +++++----- helm/dscp-ipfs/Chart.yaml | 6 +++--- helm/dscp-ipfs/values.yaml | 12 ++++++------ package-lock.json | 4 ++-- package.json | 2 +- 7 files changed, 35 insertions(+), 35 deletions(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 324fdd6..ae7c749 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -34,7 +34,7 @@ This Code of Conduct applies both within project spaces and in public spaces whe ## Enforcement -Instances of abusive, harassing, or otherwise unacceptable behaviour may be reported by contacting the project team at [opensource@digicatapult.org.uk](mailto:opensource@digicatapult.org.uk?subject=DSCP). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team's obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. +Instances of abusive, harassing, or otherwise unacceptable behaviour may be reported by contacting the project team at [opensource@digicatapult.org.uk](mailto:opensource@digicatapult.org.uk?subject=Veritable). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team's obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 22cddb3..982a335 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,8 +1,8 @@ -# Contributing to dscp-ipfs +# Contributing to veritable-ipfs Firstly, we would like to thank you for taking the time to contribute! -The following is a set of guidelines for contributing to DSCP and its packages, which are hosted on the [digicatapult](https://github.com/digicatapult) organisation on GitHub. These are mostly guidelines, not rules. Use your best judgement, and feel free to propose changes to this document in a pull request. +The following is a set of guidelines for contributing to Veritable and its packages, which are hosted on the [digicatapult](https://github.com/digicatapult) organisation on GitHub. These are mostly guidelines, not rules. Use your best judgement, and feel free to propose changes to this document in a pull request. #### Table Of Contents @@ -24,7 +24,7 @@ The following is a set of guidelines for contributing to DSCP and its packages, ## Code of Conduct -This project and all those participating in it are governed by the [Digital Catapult's Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behaviour to [opensource@digicatapult.org.uk](mailto:opensource@digicatapult.org.uk?subject=DSCP). +This project and all those participating in it are governed by the [Digital Catapult's Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behaviour to [opensource@digicatapult.org.uk](mailto:opensource@digicatapult.org.uk?subject=Veritable). ## FAQs @@ -34,7 +34,7 @@ We don't have any frequently asked questions yet. ### Reporting Bugs -This section guides you through submitting a bug report for dscp-ipfs. Following these guidelines helps maintainers and the community understand your report :pencil:, reproduce the behaviour :computer: :computer:, and find related reports :mag_right:. +This section guides you through submitting a bug report for veritable-ipfs. Following these guidelines helps maintainers and the community understand your report :pencil:, reproduce the behaviour :computer: :computer:, and find related reports :mag_right:. Before creating bug reports, please check [this list](#before-submitting-a-bug-report) as you might find out that you don't need to create one. When you are creating a bug report, please [include as many details as possible](#how-do-i-submit-a-good-bug-report). Fill out [the required template](https://github.com/digicatapult/dscp-ipfs/blob/main/.github/ISSUE_TEMPLATE/bug_report.md), the information it asks for helps us resolve issues faster. @@ -56,24 +56,24 @@ Explain the problem and include additional details to help maintainers reproduce - **Describe the behaviour you observed after following the steps** and point out what exactly is the problem with that behaviour. - **Explain which behaviour you expected to see instead and why.** - **Include screenshots and animated GIFs** which show you following the described steps and clearly demonstrate the problem. If you use the keyboard while following the steps, \*\*record the GIF with the [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/Xaviju/byzanzUI) on Linux. -- **If you're reporting that dscp-ipfs crashed**, include a crash report with a stack trace from the operating system. On macOS, the crash report will be available in `Console.app` under "Diagnostic and usage information" > "User diagnostic reports". Include the crash report in the issue in a [code block](https://help.github.com/articles/markdown-basics/#multiple-lines), a [file attachment](https://help.github.com/articles/file-attachments-on-issues-and-pull-requests/), or put it in a [gist](https://gist.github.com/) and provide link to that gist. +- **If you're reporting that veritable-ipfs crashed**, include a crash report with a stack trace from the operating system. On macOS, the crash report will be available in `Console.app` under "Diagnostic and usage information" > "User diagnostic reports". Include the crash report in the issue in a [code block](https://help.github.com/articles/markdown-basics/#multiple-lines), a [file attachment](https://help.github.com/articles/file-attachments-on-issues-and-pull-requests/), or put it in a [gist](https://gist.github.com/) and provide link to that gist. - **If the problem wasn't triggered by a specific action**, describe what you were doing before the problem happened and share more information using the guidelines below. Provide more context by answering these questions: -- **Did the problem start happening recently** (e.g. after updating to a new version of dscp-ipfs) or was this always a problem? -- If the problem started happening recently, **can you reproduce the problem in an older version of dscp-ipfs?** What's the most recent version in which the problem doesn't happen? You can checkout older versions of dscp-ipfs from [the releases page](https://github.com/digicatapult/dscp-ipfs/releases). +- **Did the problem start happening recently** (e.g. after updating to a new version of veritable-ipfs) or was this always a problem? +- If the problem started happening recently, **can you reproduce the problem in an older version of veritable-ipfs?** What's the most recent version in which the problem doesn't happen? You can checkout older versions of veritable-ipfs from [the releases page](https://github.com/digicatapult/dscp-ipfs/releases). - **Can you reliably reproduce the issue?** If not, provide details about how often the problem happens and under which conditions it normally happens. Include details about your configuration and environment: -- **Which version of dscp-ipfs are you using?** You can get the exact version from the version attribute within package.json. -- **What's the name and version of the OS you've deployed dscp-ipfs to**? -- **Are you running dscp-ipfs in a virtual machine?** If so, which VM software are you using and which operating systems and versions are used for the host and the guest? +- **Which version of veritable-ipfs are you using?** You can get the exact version from the version attribute within package.json. +- **What's the name and version of the OS you've deployed veritable-ipfs to**? +- **Are you running veritable-ipfs in a virtual machine?** If so, which VM software are you using and which operating systems and versions are used for the host and the guest? ### Suggesting Enhancements -This section guides you through submitting an enhancement suggestion for dscp-ipfs, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion :pencil: and find related suggestions :mag_right:. +This section guides you through submitting an enhancement suggestion for veritable-ipfs, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion :pencil: and find related suggestions :mag_right:. Before creating enhancement suggestions, please check [this list](#before-submitting-an-enhancement-suggestion) as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please [include as many details as possible](#how-do-i-submit-a-good-enhancement-suggestion). Fill in [the template](https://github.com/digicatapult/dscp-ipfs/blob/main/.github/ISSUE_TEMPLATE/feature_request.md), including the steps that you imagine you would take if the feature you're requesting existed. @@ -89,19 +89,19 @@ Enhancement suggestions are tracked as [GitHub issues](https://guides.github.com - **Provide a step-by-step description of the suggested enhancement** in as many details as possible. - **Provide specific examples to demonstrate the steps**. Include copy/pasteable snippets which you use in those examples, as [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines). - **Describe the current behaviour** and **explain which behaviour you expected to see instead** and why. -- **Include screenshots and animated GIFs** which help you demonstrate the steps or point out the part of dscp-ipfs which the suggestion is related to. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux. -- **Explain why this enhancement would be useful** to most dscp-ipfs users. +- **Include screenshots and animated GIFs** which help you demonstrate the steps or point out the part of veritable-ipfs which the suggestion is related to. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux. +- **Explain why this enhancement would be useful** to most veritable-ipfs users. - **List some other text editors or applications where this enhancement exists.** -- **Specify which version of dscp-ipfs you're using.** You can get the exact version from the version attribute within package.json. -- **What's the name and version of the OS you've deployed dscp-ipfs to**? +- **Specify which version of veritable-ipfs you're using.** You can get the exact version from the version attribute within package.json. +- **What's the name and version of the OS you've deployed veritable-ipfs to**? ### Pull Requests The process described here has several goals: -- Maintain dscp-ipfs's quality +- Maintain veritable-ipfs's quality - Fix problems that are important to users -- Enable a sustainable system for dscp-ipfs's maintainers to review contributions +- Enable a sustainable system for veritable-ipfs's maintainers to review contributions Please follow these steps to have your contribution considered by the maintainers: diff --git a/README.md b/README.md index 599f8de..dc5bb31 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# dscp-ipfs +# veritable-ipfs -Manages a go-ipfs instance maintaining the private network swarm key based on the value from a `dscp-node` instance. +Manages a go-ipfs instance maintaining the private network swarm key based on the value from a `veritable-node` instance. ## Local development > install dependencies @@ -18,15 +18,15 @@ npm run dev ## Environment Variables -`dscp-ipfs` is configured primarily using environment variables as follows: +`veritable-ipfs` is configured primarily using environment variables as follows: | variable | required | default | description | | :---------------------------- | :------: | :----------: | :----------------------------------------------------------------------------------- | | SERVICE_TYPE | N | `dscp-ipfs` | Service type to appear in logs | | PORT | N | `80` | The port for the API to listen on | | LOG_LEVEL | N | `info` | Logging level. Valid values are [`trace`, `debug`, `info`, `warn`, `error`, `fatal`] | -| NODE_HOST | Y | | Hostname of the `dscp-node` to use as the swarm key source | -| NODE_PORT | N | `9943` | Websocket port of the `dscp-node` to use as the swarm key source | +| NODE_HOST | Y | | Hostname of the `veritable-node` to use as the swarm key source | +| NODE_PORT | N | `9943` | Websocket port of the `veritable-node` to use as the swarm key source | | IPFS_PATH | N | `/ipfs` | IPFS data storage path | | IPFS_EXECUTABLE | N | `ipfs` | Executable to use to run go-ipfs | | IPFS_ARGS | N | `["daemon"]` | JSON array of strings to pass as arguments to the `IPFS_EXECUTABLE` | diff --git a/helm/dscp-ipfs/Chart.yaml b/helm/dscp-ipfs/Chart.yaml index 6d4a0f9..e604f14 100644 --- a/helm/dscp-ipfs/Chart.yaml +++ b/helm/dscp-ipfs/Chart.yaml @@ -1,8 +1,8 @@ apiVersion: v2 name: dscp-ipfs -appVersion: '2.8.1' -description: A Helm chart for dscp-ipfs -version: '2.8.1' +appVersion: '2.9.1' +description: A Helm chart for veritable-ipfs +version: '2.9.1' type: application dependencies: - name: dscp-node diff --git a/helm/dscp-ipfs/values.yaml b/helm/dscp-ipfs/values.yaml index fc2b612..42320fc 100644 --- a/helm/dscp-ipfs/values.yaml +++ b/helm/dscp-ipfs/values.yaml @@ -10,11 +10,11 @@ config: logLevel: info ipfsApiPort: 5001 ipfsSwarmPort: 4001 - ipfsDataPath: "/ipfs" - ipfsCommand: "/usr/local/bin/ipfs" + ipfsDataPath: '/ipfs' + ipfsCommand: '/usr/local/bin/ipfs' ipfsArgs: - daemon - - "--migrate" + - '--migrate' # ipfsBootNodeAddress: /dnsaddr/blah.test.com/p2p/PeerId # Valid Format for this is /multiaddr/PeerId see https://github.com/multiformats/multiaddr ipfsLogLevel: info ipfsSwarmAddrFilters: @@ -52,11 +52,11 @@ statefulSet: image: repository: digicatapult/dscp-ipfs pullPolicy: IfNotPresent - tag: 'v2.8.1' + tag: 'v2.9.1' storage: - storageClass: "" - dataVolumeSize: 1 # in Gigabytes + storageClass: '' + dataVolumeSize: 1 # in Gigabytes dscpNode: enabled: true diff --git a/package-lock.json b/package-lock.json index 4fe273f..feb32c2 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@digicatapult/dscp-ipfs", - "version": "2.8.1", + "version": "2.9.1", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "@digicatapult/dscp-ipfs", - "version": "2.8.1", + "version": "2.9.1", "license": "Apache-2.0", "dependencies": { "@digicatapult/dscp-node": "^4.4.6", diff --git a/package.json b/package.json index f249cfd..070a2fc 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@digicatapult/dscp-ipfs", - "version": "2.8.1", + "version": "2.9.1", "description": "Service for DSCP", "main": "app/index.js", "type": "module", From 668f769ab0ea5aa21afd0c6d8f0efd7996a228b6 Mon Sep 17 00:00:00 2001 From: Mark Addis <35331926+nitro-marky@users.noreply.github.com> Date: Fri, 25 Nov 2022 15:09:23 +0000 Subject: [PATCH 2/3] Helm lint --- helm/dscp-ipfs/Chart.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/helm/dscp-ipfs/Chart.yaml b/helm/dscp-ipfs/Chart.yaml index e604f14..fc5e4ba 100644 --- a/helm/dscp-ipfs/Chart.yaml +++ b/helm/dscp-ipfs/Chart.yaml @@ -1,7 +1,7 @@ apiVersion: v2 name: dscp-ipfs appVersion: '2.9.1' -description: A Helm chart for veritable-ipfs +description: A Helm chart for dscp-ipfs version: '2.9.1' type: application dependencies: From a7082166ef4d49c9b51dad977398262c7dbdd53b Mon Sep 17 00:00:00 2001 From: Mark Addis <35331926+nitro-marky@users.noreply.github.com> Date: Fri, 25 Nov 2022 15:31:10 +0000 Subject: [PATCH 3/3] Helm lint --- helm/dscp-ipfs/Chart.yaml | 2 +- helm/dscp-ipfs/values.yaml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/helm/dscp-ipfs/Chart.yaml b/helm/dscp-ipfs/Chart.yaml index fc5e4ba..e604f14 100644 --- a/helm/dscp-ipfs/Chart.yaml +++ b/helm/dscp-ipfs/Chart.yaml @@ -1,7 +1,7 @@ apiVersion: v2 name: dscp-ipfs appVersion: '2.9.1' -description: A Helm chart for dscp-ipfs +description: A Helm chart for veritable-ipfs version: '2.9.1' type: application dependencies: diff --git a/helm/dscp-ipfs/values.yaml b/helm/dscp-ipfs/values.yaml index 42320fc..40ae05f 100644 --- a/helm/dscp-ipfs/values.yaml +++ b/helm/dscp-ipfs/values.yaml @@ -56,7 +56,7 @@ image: storage: storageClass: '' - dataVolumeSize: 1 # in Gigabytes + dataVolumeSize: 1 # in Gigabytes dscpNode: enabled: true