dargstack_rgen 0.6.47 → 0.6.50

package/.github/workflows/docker.yml

@@ -7,22 +7,35 @@ on:
     types: [published]
 
 jobs:
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Git checkout
+        uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748 # tag=v3.0.1
+      - name: Install
+        run: |
+          yarn install --frozen-lockfile
+      - name: Test
+        run: |
+          yarn test
   docker:
+    needs: test
     name: Docker
-    uses: dargmuesli/github-actions/.github/workflows/docker.yml@0.6.7
+    uses: dargmuesli/github-actions/.github/workflows/docker.yml@0.7.0
     secrets:
       DOCKER_HUB_ACCESS_TOKEN: ${{ secrets.DOCKER_HUB_ACCESS_TOKEN }}
       DOCKER_HUB_USER_NAME: ${{ secrets.DOCKER_HUB_USER_NAME }}
   release-semantic:
     needs: docker
     name: Semantic Release
-    uses: dargmuesli/github-actions/.github/workflows/release-semantic.yml@0.6.7
+    uses: dargmuesli/github-actions/.github/workflows/release-semantic.yml@0.7.0
     secrets:
       GH_TOKEN: ${{ secrets.GH_TOKEN }}
       NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
   release-assets:
     needs: release-semantic
     name: Release Assets
-    uses: dargmuesli/github-actions/.github/workflows/release-assets.yml@0.6.7
+    uses: dargmuesli/github-actions/.github/workflows/release-assets.yml@0.7.0
     with:
       TARGET: development

package/.github/workflows/release-schedule.yml

@@ -7,6 +7,6 @@ on:
 jobs:
   release-schedule:
     name: 'Release: Scheduled'
-    uses: dargmuesli/github-actions/.github/workflows/release-schedule.yml@0.6.7
+    uses: dargmuesli/github-actions/.github/workflows/release-schedule.yml@0.7.0
     secrets:
       GH_TOKEN: ${{ secrets.GH_TOKEN }}

package/CHANGELOG.md

@@ -1,3 +1,24 @@
+## [0.6.50](https://github.com/dargmuesli/dargstack_rgen/compare/0.6.49...0.6.50) (2022-04-18)
+
+
+### Bug Fixes
+
+* **release:** schedule release ([ddc1938](https://github.com/dargmuesli/dargstack_rgen/commit/ddc1938890a0df1984839213cbe28a3f59af24ce))
+
+## [0.6.49](https://github.com/dargmuesli/dargstack_rgen/compare/0.6.48...0.6.49) (2022-04-06)
+
+
+### Bug Fixes
+
+* use new node identifier ([229cc1c](https://github.com/dargmuesli/dargstack_rgen/commit/229cc1c972d15105c95e157db53d161ecdc75c13))
+
+## [0.6.48](https://github.com/dargmuesli/dargstack_rgen/compare/0.6.47...0.6.48) (2022-03-28)
+
+
+### Bug Fixes
+
+* **release:** schedule release ([0a5834b](https://github.com/dargmuesli/dargstack_rgen/commit/0a5834b1a575b698c2de2c9b694367e8a42e0d04))
+
 ## [0.6.47](https://github.com/dargmuesli/dargstack_rgen/compare/0.6.46...0.6.47) (2022-03-21)
 
 

package/Dockerfile

@@ -1,4 +1,4 @@
-FROM node:17.7.2-alpine@sha256:1ef397a038d809785a1f787de87fbb496d10ee1b0565068289da1c5cac0d1fe4 AS development
+FROM node:17.9.0-alpine@sha256:f61706c2cb120c06cf4fdcf60a2822a804b0bd90b6b2209be1ee00db1d33130c AS development
 
 ENV HUSKY=0
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "dargstack_rgen",
-  "version": "0.6.47",
-  "scheduleVersion": "0.6.47",
+  "version": "0.6.50",
+  "scheduleVersion": "0.6.50",
   "description": "Generates a DargStack stack project readme.",
   "main": "src/generator.js",
   "repository": "https://github.com/dargmuesli/dargstack_rgen.git",
@@ -14,15 +14,15 @@
     "deepmerge": "4.2.2",
     "diff": "5.0.0",
     "json2md": "1.12.0",
-    "yaml": "1.10.2",
-    "yargs": "17.4.0"
+    "yaml": "2.0.1",
+    "yargs": "17.4.1"
   },
   "devDependencies": {
     "@commitlint/cli": "16.2.3",
     "@commitlint/config-conventional": "16.2.1",
-    "eslint": "8.11.0",
+    "eslint": "8.13.0",
     "eslint-config-standard": "16.0.3",
-    "eslint-plugin-import": "2.25.4",
+    "eslint-plugin-import": "2.26.0",
     "eslint-plugin-node": "11.1.0",
     "eslint-plugin-promise": "6.0.0",
     "eslint-plugin-standard": "4.1.0",
@@ -30,6 +30,7 @@
     "shx": "0.3.4"
   },
   "scripts": {
-    "prepare": "if [[ -d '.git' && -d '.husky' ]]; then husky install && shx rm -rf .git/hooks && shx ln -s ../.husky .git/hooks; fi"
+    "prepare": "if [[ -d '.git' && -d '.husky' ]]; then husky install && shx rm -rf .git/hooks && shx ln -s ../.husky .git/hooks; fi",
+    "test": "node src/generator.js -p test/example_stack -v"
   }
 }

package/src/generator.js

@@ -82,7 +82,7 @@ for (let i = 0; i < documentItems.length; i++) {
   const documentItem = documentItems[i]
   const elementItems = documentItem.value.items
 
-  if (documentItem.value.type !== 'MAP') {
+  if (!yaml.isMap(documentItem.value)) {
     continue
   }
 
@@ -119,7 +119,7 @@ if (productionYaml !== undefined && productionYaml.contents !== null) {
 for (let i = 0; i < documentItems.length; i++) {
   const documentItem = documentItems[i]
 
-  if (documentItem.value === undefined || documentItem.value.type !== 'MAP') {
+  if (documentItem.value === undefined || !yaml.isMap(documentItem.value)) {
     continue
   }
 

package/test/example_stack/README.md

@@ -0,0 +1,98 @@
+# example_stack
+
+
+The Docker stack configuration for [example.de](https://example.de/).
+
+This project is deployed in accordance to the [DargStack template](https://github.com/dargmuesli/dargstack_template/) to make deployment a breeze. It is closely related to [example's source code](https://github.com/dargmuesli/example/).
+
+## Table of Contents
+
+
+ 1. [configs](#configs)
+    
+ 2. [secrets](#secrets)
+    
+ 3. [services](#services)
+    
+ 4. [volumes](#volumes)
+    
+
+## configs
+
+
+ - ### `another_rc`
+    
+    Another's configuration file.
+    
+ - ### `some_rc`
+    
+    Some's configuration file.
+    
+
+## secrets
+
+
+ - ### `postgres_password`
+    
+    The database default user's password.
+    
+ - ### `postgres_user`
+    
+    The database default user's name.
+    
+ - ### `traefik_cf-dns-api-token` ![production](https://img.shields.io/badge/-production-informational.svg?style=flat-square)
+    
+    The DNS provider's DNS API token.
+    
+ - ### `traefik_cf-zone-api-token` ![production](https://img.shields.io/badge/-production-informational.svg?style=flat-square)
+    
+    The DNS provider's zone API token.
+    
+
+## services
+
+
+ - ### `adminer`
+    
+    You can access the database's frontend at [adminer.example.test](https://adminer.example.test/).
+    This information is required for login:
+    
+    |          |                     |
+    | -------- | ------------------- |
+    | System   | PostgreSQL          |
+    | Server   | postgres            |
+    | Username | [postgres_user]     |
+    | Password | [postgres_password] |
+    | Database | [postgres_db]       |
+    
+    Values in square brackets are [Docker secrets](https://docs.docker.com/engine/swarm/secrets/).
+    
+ - ### `postgres`
+    
+    You can access the database via `adminer`.
+    
+ - ### `postgres_backup` ![production](https://img.shields.io/badge/-production-informational.svg?style=flat-square)
+    
+    Backup service for `postgres`.
+    
+ - ### `traefik_certs-dumper` ![production](https://img.shields.io/badge/-production-informational.svg?style=flat-square)
+    
+    See [DargStack template: certificates](https://github.com/dargmuesli/dargstack_template/#certificates).
+    
+
+## volumes
+
+
+ - ### `acme_data` ![production](https://img.shields.io/badge/-production-informational.svg?style=flat-square)
+    
+    The reverse proxy's certificate data.
+    
+ - ### `portainer_data`
+    
+    The container manager's data.
+    
+ - ### `postgres_data`
+    
+    The database's data.
+    
+

package/test/example_stack/src/development/stack.yml

@@ -0,0 +1,55 @@
+# example.de
+# https://example.de/
+# example
+# https://github.com/dargmuesli/example/
+---
+configs:
+  some_rc:
+  # Some's configuration file.
+    file: ../production/configurations/some/.some.js
+  another_rc:
+  # Another's configuration file.
+    file: ../production/configurations/another/.another.js
+secrets:
+  postgres_password:
+  # The database default user's password.
+    file: ./secrets/postgres/password.secret
+  postgres_user:
+  # The database default user's name.
+    file: ./secrets/postgres/user.secret
+services:
+  adminer:
+  # You can access the database's frontend at [adminer.example.test](https://adminer.example.test/).
+  # This information is required for login:
+  #
+  # |          |                     |
+  # | -------- | ------------------- |
+  # | System   | PostgreSQL          |
+  # | Server   | postgres            |
+  # | Username | [postgres_user]     |
+  # | Password | [postgres_password] |
+  # | Database | [postgres_db]       |
+  #
+  # Values in square brackets are [Docker secrets](https://docs.docker.com/engine/swarm/secrets/).
+    image: adminer:4.8.1-standalone@sha256:b9125cae28bf249d1d2e9c4ffa42143a39ce1edc0eccbaf83e48ad6fbb3171b6
+    volumes:
+    - ../production/configurations/adminer/adminer.css:/var/www/html/adminer.css:ro
+  postgres:
+  # You can access the database via `adminer`.
+    environment:
+      POSTGRES_PASSWORD_FILE: /run/secrets/postgres_password
+      POSTGRES_USER_FILE: /run/secrets/postgres_user
+    image: postgres:14.2-alpine@sha256:20e49432a20e1a63bb985977c32ec8f110bc609b93de35ad4f19c5486abcefaa
+    secrets:
+    - postgres_password
+    - postgres_user
+    volumes:
+    - postgres_data:/var/lib/postgresql/data/
+version: "3.6"
+volumes:
+  portainer_data:
+  # The container manager's data.
+    {}
+  postgres_data:
+  # The database's data.
+    {}

package/test/example_stack/src/production/production.yml

@@ -0,0 +1,30 @@
+secrets:
+  traefik_cf-dns-api-token:
+  # The DNS provider's DNS API token.
+    external: true
+  traefik_cf-zone-api-token:
+  # The DNS provider's zone API token.
+    external: true
+services:
+  postgres_backup:
+  # Backup service for `postgres`.
+    environment:
+      POSTGRES_HOST: postgres
+      POSTGRES_PASSWORD_FILE: /run/secrets/postgres_password
+      POSTGRES_USER_FILE: /run/secrets/postgres_user
+    image: prodrigestivill/postgres-backup-local:14-alpine@sha256:78b41a63ee65fffddc1490e8dca49f9783b99e605aab8710cb57b7ce88d63c1a
+    secrets:
+    - postgres_password
+    - postgres_user
+    volumes:
+    - postgres_data:/var/lib/postgresql/data/
+  traefik_certs-dumper:
+  # See [DargStack template: certificates](https://github.com/dargmuesli/dargstack_template/#certificates).
+    image: ldez/traefik-certs-dumper:v2.8.1@sha256:2734462fc8290feab0e34a00d5f3e4992ba74f8e3712d74efff7ae703d0e7e87
+    volumes:
+    - acme_data:/etc/traefik/acme/
+version: "3.7"
+volumes:
+  acme_data:
+  # The reverse proxy's certificate data.
+    {}