https://github.com/quantco/ui-actions

Monorepo for UI related github actions
https://github.com/quantco/ui-actions

ui

Last synced: about 2 months ago
JSON representation

Monorepo for UI related github actions

• Host: GitHub
• URL: https://github.com/quantco/ui-actions
• Owner: Quantco
• License: mit
• Created: 2023-01-09T14:24:28.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-12-31T12:22:41.000Z (about 1 year ago)
• Last Synced: 2024-04-16T01:24:06.370Z (9 months ago)
• Topics: ui
• Language: TypeScript
• Homepage:
• Size: 1.36 MB
• Stars: 3
• Watchers: 5
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# Monorepo for UI related actions

![GitHub tag (latest semver)](https://img.shields.io/github/v/tag/Quantco/ui-actions?color=%23000000&label=latest%20version&sort=semver)

This repo includes the following actions:

- [version-metadata](./version-metadata)

- [publish](./publish)

> This repo uses [pnpm](https://pnpm.io).

## Example

For more detailed explanations see the respective readmes.

Nevertheless here's a minimal example of these actions in use.

```yml

- id: version-metadata

  uses: Quantco/ui-actions/version-metadata@v1

  with:

    file: lib/package.json

    token: ${{ secrets.GITHUB_TOKEN }}

- name: Determine last published version

  run: |

    set +e # disable pipefail, error handling is done manually below

    # get version or fall back to `0.0.0` if the package doesn't exist (yet)

    echo "CI_PUBLISHED_VERSION=$(npm show  version || echo "0.0.0")" >> $GITHUB_ENV

  env:

    NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

  

- id: publish

  uses: Quantco/ui-actions/publish@v1

  with:

    increment-type: pre-release

    relevant-files: '[".github/**", "lib/**"]'

    package-json-file-path: lib/package.json

    latest-registry-version: ${{ env.CI_PUBLISHED_VERSION }}

    version-metadata-json: ${{ steps.version-metadata.outputs.json }}

- name: publish npm package

  if: steps.publish.outputs.publish == 'true'

  run: |

    echo "Publishing version ${{ steps.publish.outputs.version }}"

    npm version --git-tag-version false --allow-same-version true ${{ steps.publish.outputs.version }}

    npm publish

  env:

    NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: Create action summary

  run: |

    echo "$SUMMARY" >> $GITHUB_STEP_SUMMARY

  env:

    SUMMARY: ${{ steps.publish.outputs.reason }}

```

## Development

`ui-actions` uses `ui-actions` itself for creating git tags based on the version in the package.json files (see [`.github/workflows/build.yml`](.github/workflows/build.yml)).

Whenever you want to release a new version you just have to increment the version number in **both** `publish/package.json` and `version-metadata/package.json`.

For local testing you can use the `test.sh` files.