From 7405b56a2a1423bf6a5233e28baac537dfad4f13 Mon Sep 17 00:00:00 2001 From: Kor Dwarshuis Date: Wed, 12 Feb 2025 17:57:03 +0100 Subject: [PATCH] =?UTF-8?q?Update=20=E2=80=9Cupdate=E2=80=9D=20instruction?= =?UTF-8?q?s?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../updating.md | 48 +++++-------------- 1 file changed, 13 insertions(+), 35 deletions(-) diff --git a/docs/administrative-and-maintenance-tasks/updating.md b/docs/administrative-and-maintenance-tasks/updating.md index 6353b9b0..a0d38c9c 100644 --- a/docs/administrative-and-maintenance-tasks/updating.md +++ b/docs/administrative-and-maintenance-tasks/updating.md @@ -7,12 +7,7 @@ sidebar_position: 2 ## Introduction -Updating Spec-Up-T involves two key processes: - -1. Updating **your own installation**, which you initially set up using the Spec-Up-T installer. -2. Updating the **Spec-Up-T npm package** to ensure you have the latest features and fixes. - -This guide provides step-by-step instructions to update your installation. +This guide provides step-by-step instructions to update your **Spec-Up-T** installation. ## Prerequisites @@ -23,32 +18,13 @@ Before proceeding, ensure you have the following tools and knowledge: - Installed Node.js and npm. - Access to the Spec-Up-T GitHub repository. -## Updating Your Own Installation - -Updating your installation requires manually copying and updating files from the boilerplate provided in the Spec-Up-T repository. Follow these steps: - -### 1. Retrieve Source Files from the Installer - -The necessary files can be found in the [`spec-up-t-boilerplate`](https://github.com/blockchainbird/spec-up-t-starter-pack/tree/main/spec-up-t-boilerplate)[ directory](https://github.com/blockchainbird/spec-up-t-starter-pack/tree/main/spec-up-t-boilerplate). - -#### Methods to Download Files - -- Clone the repository using Git: - ```bash - git clone https://github.com/blockchainbird/spec-up-t-starter-pack.git - ``` -- Download a ZIP of the repository and extract it locally. -- Manually copy the content of individual files into your local setup. - -Ensure the file and directory names in your local installation match those in the GitHub source repository. If they differ, rename your local files to align with the repository structure. - -### 2. Update `.gitignore` +## Update -Compare your `.gitignore` file with the boilerplate version. Copy any entries missing in your file from the boilerplate. +Updating your **Spec-Up-T** installation requires the following steps: -### 3. Configure GitHub Token +### 1. Configure GitHub Token -If you are using a GitHub token for authentication: +You need a GitHub Personal Access Token for authentication. [Instructions how to create a GitHub Personal Access Token](../getting-started/github-token.md). - Rename `.env.example` to `.env`. - Add your token in the `.env` file as follows: @@ -56,26 +32,28 @@ If you are using a GitHub token for authentication: GITHUB_TOKEN= ``` -### 4. Update `specs.json` +### 2. Update `specs.json` -Compare your `specs.json` with the boilerplate version. Use a file comparison tool like `diff` or `Meld` to identify differences. Ensure all entries align with the boilerplate. +Compare your `specs.json` with [the boilerplate version](https://github.com/trustoverip/spec-up-t/blob/master/src/install-from-boilerplate/boilerplate/specs.json). Use a file comparison tool like `diff` or `Meld` to identify differences. Ensure all entries align with the boilerplate. -### 5. Set Up Terms +### 3. Set Up Terms #### `terms-and-definitions-intro.md` - Create a file named `terms-and-definitions-intro.md` in the `/specs` directory. - Add an intro text or leave it empty. Ensure this file is referenced in `specs.json`. -### 6. Update +### 4. Update -Update your npm dependencies and more by running: +Run the update function: ```bash npm run custom-update ``` -This will run `npm update` first and after that a custom script. +This will run +1. `npm update` (which will update the `spec-up-t` package, and other packages) +2. a custom script. ## Completion