Theme:
TypeScript

How to publish

We publish the Style Guide as npm package into Azure DevOps Artifactory. We also publish the documentation of the Style Guide as an Azure Static Apps.

Before publish a new version, be sure that the version number in the package.json in the development branch is higher then in the package.json of the main branch (link). Also check the Release Notes if every changes of the new version is correctly documented.

To publish both (npm package & documentation), you must merge the development branch into the main branch:

  1. WARNING read below for the current .npmrc bug
  2. goto New pull request
  3. select development into main
  4. give the pull request a title, for example the new version number, like “v1.15.0”
  5. somebody should approve the changes
  6. merge the changes, check the build pipeline
  7. after the build pipeline runs correctly, check if the npm package is correctly published (see Artifacts) and also check the documentation
  8. WARNING undo all changes in the .npmrc file

Docu Docu

npmrc bug

Currently we have a bug while publishing the documentation with the normal development.

The contents of the .npmrc are treated with an “access denied” while the pipeline tries to publish the documentation to azure static apps. This seems to be an error on the part of the publish process in Azure.

To avoid this error, you have to adjust the .npmrc before merging the development branch into the main branch.

@finanzen-net:registry=https://pkgs.dev.azure.com/finanzennet/finando/_packaging/finanzen-net/npm/registry/
always-auth=true

Replace the text with your personal npmrc auth token. You can find them here

Docu

; begin auth token
//pkgs.dev.azure.com/finanzennet/finando/_packaging/finanzen-net/npm/registry/:username=finanzennet
//pkgs.dev.azure.com/finanzennet/finando/_packaging/finanzen-net/npm/registry/:_password=[BASE64_ENCODED_PERSONAL_ACCESS_TOKEN]
//pkgs.dev.azure.com/finanzennet/finando/_packaging/finanzen-net/npm/registry/:email=npm requires email to be set but doesn't use the value
//pkgs.dev.azure.com/finanzennet/finando/_packaging/finanzen-net/npm/:username=finanzennet
//pkgs.dev.azure.com/finanzennet/finando/_packaging/finanzen-net/npm/:_password=[BASE64_ENCODED_PERSONAL_ACCESS_TOKEN]
//pkgs.dev.azure.com/finanzennet/finando/_packaging/finanzen-net/npm/:email=npm requires email to be set but doesn't use the value
; end auth token

After you changed the .npmrc in the development branch, you can merge the development branch into the main branch, see chapter above.

After the merge is done, you must redo the changes in the npmrc. For development, the .npmrc file must contain:

@finanzen-net:registry=https://pkgs.dev.azure.com/finanzennet/finando/_packaging/finanzen-net/npm/registry/
always-auth=true