generator-jhipster-scripts

JHipster blueprint, easily run CI on blueprints.

Introduction

This blueprint customizes the generated project to be more friendly for CI. Creates a series of scripts to run CI.

This is a JHipster blueprint, that is meant to be used in a JHipster application.

Prerequisites

As this is a JHipster blueprint, we expect you have JHipster and its related tools already installed:

• Installing JHipster

Installation

To install this blueprint:

npm install -g generator-jhipster-scripts

Usage

To use this blueprint, run the below command

jhipster --blueprints scripts

Github Actions Workflow Example

name: Integration
on: [push]
env:
  JHI_PROFILE: prod
  SPRING_OUTPUT_ANSI_ENABLED: NEVER
  SPRING_JPA_SHOW_SQL: false
  JHI_DISABLE_WEBPACK_LOGS: true
  JHI_E2E_HEADLESS: true
  NG_CLI_ANALYTICS: false

jobs:
  applications:
    name: ${{ matrix.jdl-file }} ${{ matrix.jhi-gen-version }}
    runs-on: ${{ matrix.os }}
    if: >-
      !contains(github.event.head_commit.message, '[ci skip]') &&
      !contains(github.event.head_commit.message, '[skip ci]')
    timeout-minutes: 40
    strategy:
      fail-fast: false
      matrix:
        node_version:
          - 12.14.0
        os:
          - ubuntu-latest
        jdl-file:
          - relative_path_to_jdl.jdl
        jhi-gen-version:
          - jhipster/generator-jhipster#master
          - generator-jhipster@latest
    steps:
      #----------------------------------------------------------------------
      # Install all tools and check configuration
      #----------------------------------------------------------------------
      - uses: actions/setup-node@v1
        with:
          node-version: ${{ matrix.node_version }}
      - uses: actions/setup-java@v1
        with:
          java-version: '11.x'

      #----------------------------------------------------------------------
      # Checkout Sample Repository
      #----------------------------------------------------------------------
      - name: Checkout sample repository
        uses: actions/checkout@v2

      #----------------------------------------------------------------------
      # Install JHipster
      #----------------------------------------------------------------------
      - name: Install jhipster
        run: npm install -g ${{ matrix.jhi-gen-version }}

      #----------------------------------------------------------------------
      # Install scripts blueprint
      #----------------------------------------------------------------------
      - name: Install scripts blueprint
        run: npm install -g generator-jhipster-scripts

      #----------------------------------------------------------------------
      # Create Application folder
      #----------------------------------------------------------------------
      - name: Create application folder
        run: mkdir app
 
      #----------------------------------------------------------------------
      # Copy jdl file
      #----------------------------------------------------------------------
      - name: Copy jdl files
        run: cp ${{ github.workspace }}/path-to-samples/${{ matrix.jdl-file }} .
        working-directory: app

      #----------------------------------------------------------------------
      # Generate project
      #----------------------------------------------------------------------
      - name: Project generation
        run: jhipster import-jdl ${{ matrix.jdl-file }} --no-insight --blueprints scripts --local-config-only ${{ matrix.additional-parameters }}
        working-directory: app
        id: app

      #----------------------------------------------------------------------
      # Print package.json, if doesn't exist, it's a microservice, create it.
      #----------------------------------------------------------------------
      - name: Package.json information
        run: |
          cat package.json || jhipster workspace --force --blueprints scripts --local-config-only
          cat package.json || true
          cat */package.json || true
        working-directory: app

      - name: Project information
        run: jhipster info
        working-directory: app

      - name: Folder information
        run: ls -la
        working-directory: app
 
      #----------------------------------------------------------------------
      # Tests
      #----------------------------------------------------------------------
      - name: Configure github actions
        run: npm run ci:github:configure
        working-directory: app
        id: configure

      - name: Start db containers
        run: npm run ci:test:prepare:docker
        working-directory: app

      - name: Start others containers
        if: ${{ steps.configure.outputs.docker_others == 'true' }}
        run: npm run docker:others
        working-directory: app

      - name: Frontend tests
        run: npm run ci:frontend:test
        working-directory: app

      - name: Backend info
        if: ${{ steps.app.outcome == 'success' && always() }}
        run: npm run backend:info
        working-directory: app
        id: backend_info

      - name: Backend javadoc
        if: ${{ steps.backend_info.outcome == 'success' && always() }}
        run: npm run backend:doc:test
        working-directory: app

      - name: Backend test
        if: ${{ steps.backend_info.outcome == 'success' && always() }}
        run: npm run ci:backend:test
        working-directory: app

      - name: E2E Packaging
        if: ${{ steps.app.outcome == 'success' && always() }}
        run: npm run ci:e2e:package
        working-directory: app
        id: packaging

      - name: E2E Prepare
        if: ${{ steps.packaging.outcome == 'success' && always() }}
        run: npm run ci:e2e:prepare
        timeout-minutes: 5
        working-directory: app

      - name: End-to-End
        if: ${{ steps.configure.outputs.e2e == 'true' && steps.packaging.outcome == 'success' && always() }}
        run: npm run ci:e2e:run
        working-directory: app

License

MIT © Marcelo Shima