Skip to content

Latest commit

 

History

History
259 lines (175 loc) · 7.33 KB

README.md

File metadata and controls

259 lines (175 loc) · 7.33 KB
Raw

Digital Identity Vocabulary Specification

About

This specification intends to describe a Linked Data vocabulary for asserting Verifiable Credentials related to identity proofing and verification.

This repository produces the following artifacts:

Further development could include:

  • Automated tests
  • Documentation
  • JSON-LD
  • OpenAPI description for our various OAuth providers

Getting started

When checking out, ensure you update/initialise submodules recursively, these are used for certain dependencies, e.g.

git submodule update --init --recursive

Manually

  • Install Python for example by installing pyenv;
  • Install poetry so that you can install and run this project's Python depdenencies;
  • Install Node (and NPM) for example by installing NVM;
  • Install some build and test command line tools we require globally (or into your environment, somehow)
poetry install

npm install
npm install -g [email protected] [email protected]

If the above dependencies/versions need to change, please update the [devcontainer configuration](.devcontainer/devcontainer.json) also.

Dev Container

Open the repo in a development container in vscode, and the pre-requisites will be pre-installed

Modifying the source LinkML

Edit the files in /v1/linkml-schemas/

❗ Class names are all post-fixed with Class. This is because otherwise, when generating documentation on MacOS, classes whose names clash with slot names (eg Name and name) will be lost, see [https://github.com/linkml/linkml/issues/632](LinkML Issue 632).

Generating JSON Schemas and compile the documentation site

./scripts/build

Run tests

Test the example files against the JSON schemas using an independent JSON-Schema library:

./scripts/test

Run a local server

poetry run mkdocs serve

If the styling appears off, you may need to run the build script first

Deploy

./scripts/deploy

Using the TypeScript types

Type definition files (.d.ts) are published with each tagged version of this repository. You can add these as a dependency in your TypeScript/Node.js project.

These are published as an npm module to GitHub Packages.

Note Check out the sample project for an example.

Add the dependency

You can add it as a dependency using npm:

npm install @govuk-one-login/[email protected]

Or in your package.json dependencies:

"@govuk-one-login/data-vocab": "1.4.2"

Note See releases for the latest version.

Setting permissions

Working locally

If you are working locally, ensure you have authenticated to the @govuk-one-login npm scope in GitHub Packages:

npm login --scope=@govuk-one-login --auth-type=legacy --registry=https://npm.pkg.github.com

See Authenticating to GitHub Packages documentation.

Using the package in GitHub Actions

If you are building your project in a GitHub Actions workflow, grant access to your repository from the package settings page.

In your workflow file, set the following permission for the GitHub token:

permissions:
  packages: read

In your setup-node step, set the registry URL:

registry-url: "https://npm.pkg.github.com"
Full setup-node step example

Here's an example of the step with the registry configured:

steps: 
- name: Setup node and npm
  uses: actions/setup-node@v3
  with:
    node-version: 18
    cache: npm
    registry-url: "https://npm.pkg.github.com"

In the step where you run npm install, set the NODE_AUTH_TOKEN environment variable:

NODE_AUTH_TOKEN: ${{ github.token }}
Full npm install example

Here's an example of the step with the NODE_AUTH_TOKEN configured:

- name: Install npm dependencies
  run: "npm ci --ignore-scripts"
  env:
    NODE_AUTH_TOKEN: ${{ github.token }}

Using the Java dependency

Java data model classes are published with each tagged version of this repository. You can add these as a dependency in your Gradle/Maven project.

These are published as a Maven artifact to GitHub Packages.

Add the dependency

Gradle

Add this to build.gradle:

repositories {
    maven {
        url = uri("https://maven.pkg.github.com/govuk-one-login/data-vocab")
        credentials {
            username = project.findProperty("gpr.user") ?: System.getenv("GITHUB_USERNAME")
            password = project.findProperty("gpr.key") ?: System.getenv("GITHUB_TOKEN")
        }
    }
}

dependencies {
    implementation 'uk.gov.di.model:di-data-model:0.1.0-SNAPSHOT'
}

Learn more about consuming the dependency from Gradle.

Maven

Add the repository and server settings to ~/.m2/settings.xml per the GitHub instructions.

Add this to pom.xml:

<dependency>
  <groupId>uk.gov.di.model</groupId>
  <artifactId>di-data-model</artifactId>
  <version>0.1.0-SNAPSHOT</version>
</dependency>

Learn more about consuming the dependency from Maven.

Release process

To cut a release, you need to:

  1. Update the version in the Gradle properties file
  2. Update the version in the Node.js package.json files
  3. Commit the changes
  4. Tag the commit with the version number

To automate this process, you can use the scripts/prep_release.sh script:

./scripts/prep_release.sh <release type>

Where <release type> is one of major, minor, or patch in line with Semantic Versioning.

For example:

$ ./scripts/prep_release.sh patch

New version: 1.7.2
Commit changes and create tag (y/N)?

Once you have confirmed the version, the script will commit the changes and create a tag for the release.

Note You must push the tag and update the main branch to trigger the release process.

git push origin main --tags

On push, the GitHub Actions workflow will build and publish the artifacts to GitHub Packages and the vocab static site.