Skip to content

Commit

Permalink
docs: updates on workflows
Browse files Browse the repository at this point in the history
Added information on documentation
  • Loading branch information
ADMSK\AVROGAL1 committed Mar 18, 2021
1 parent 9b0b281 commit ee668cd
Show file tree
Hide file tree
Showing 13 changed files with 315 additions and 9 deletions.
5 changes: 5 additions & 0 deletions .bettercodehub.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
component_depth: 6
default_excludes: true
languages:
- javascript
- typescript
51 changes: 51 additions & 0 deletions .codecov.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
codecov:
notify:
wait_for_ci: false
require_ci_to_pass: true
strict_yaml_branch: master
branch: master

coverage:
precision: 2
round: down
range: '70...100'

status:
project:
default:
base: auto
informational: true
target: 95%
threshold: 1%
patch:
default:
informational: true
target: 80%
threshold: 1%
changes: no

notify:
# Wait for reasonable amount of tests to complete before
# reporting coverage
after_n_builds: 8

ignore:
- '**/generated/**'
- 'standalone'
- 'test'

parsers:
gcov:
branch_detection:
conditional: yes
loop: yes
method: no
macro: no

comment:
layout: 'header, reach, diff, flags, files, footer'
behavior: default
require_changes: false
require_base: false
require_head: true
branches: master
7 changes: 3 additions & 4 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,19 +20,18 @@ updates:
# for example, `dependabot-npm_and_yarn-next_js-acorn-6.4.1`
separator: "-"

- package-ecosystem: "pip"
# Maintain dependencies for docker
- package-ecosystem: "docker"
open-pull-requests-limit: 10
directory: "/"
schedule:
interval: "daily"
time: "16:00"
commit-message:
prefix: "pip prod"
prefix-development: "pip dev"
include: "scope"
allow:
# Allow both direct and indirect updates for all packages
- dependency-type: "all"
# Labels on pull requests for version updates only
labels:
- "pip dependencies"
- "docker"
37 changes: 37 additions & 0 deletions .github/release-drafter.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name-template: "v$RESOLVED_VERSION"
tag-template: "v$RESOLVED_VERSION"
template: |
# Changelog
$CHANGES
See details of [all code changes](https://github.com/AlexRogalskiy/stylegrams/compare/$PREVIOUS_TAG...v$RESOLVED_VERSION) since previous release
categories:
- title: "🚀 Features"
labels:
- "feature"
- "enhancement"
- title: "🐛 Bug Fixes"
labels:
- "fix"
- "bugfix"
- "bug"
- title: "🧰 Maintenance"
labels:
- "infrastructure"
- "automation"
- "documentation"
- title: "🏎 Performance"
label: "performance"
change-template: "- $TITLE @$AUTHOR (#$NUMBER)"
version-resolver:
major:
labels:
- "type: breaking"
minor:
labels:
- "type: enhancement"
patch:
labels:
- "type: bug"
- "type: maintenance"
- "type: documentation"
default: patch
4 changes: 2 additions & 2 deletions .github/workflows/codespell.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ jobs:
- name: codespell
uses: codespell-project/actions-codespell@master
with:
skip: .git,*.png,*.jpg,*.svg,*.sum,*.json,*.lock,*.js,*.html,*.css,*.scss,*.sass
ignore_words_list: aks,keyserver,atleast,dne,ser,ist,isnt,files',ba,dum,iam,te,parm
skip: .git,*.png,*.jpg,*.svg,*.sum,*.json,*.lock,*.js,*.html,*.css,*.scss,*.sass,*.js.map
ignore_words_list: aks,keyserver,atleast,dne,ser,ist,isnt,files,ba,dum,iam,te,parm
check_filenames: true
check_hidden: true
30 changes: 29 additions & 1 deletion .github/workflows/lint/.commitlintrc.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,33 @@
{
"extends": [
"@commitlint/config-conventional"
]
],
"rules": {
"type-enum": [
2,
"always",
[
"build",
"bot",
"cassandra",
"ceph",
"ci",
"cockroachdb",
"core",
"docs",
"edgefs",
"nfs",
"test",
"yugabytedb"
]
],
"body-leading-blank": [
2,
"always"
],
"footer-leading-blank": [
2,
"always"
]
}
}
4 changes: 2 additions & 2 deletions .github/workflows/release-changelog.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,14 @@ jobs:
run: |
echo ::set-output name=current_version::${GITHUB_REF#refs/tags/v}
shell: bash

- name: Build Changelog
id: github_release
uses: mikepenz/release-changelog-builder-action@main
with:
configuration: ".github/workflows/changelog/configuration.json"
owner: "AlexRogalskiy"
repo: "AlexRogalskiy"
repo: "stylegrams"
ignorePreReleases: "false"
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Expand Down
19 changes: 19 additions & 0 deletions .github/workflows/release-drafter.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# https://github.com/marketplace/actions/release-drafter
name: Release Drafter
# The branches to listen for configuration updates to .github/release-drafter.yml and for merge commits.
# Default is the repository’s default branch.
on:
push:
branches:
- development

jobs:
Drafter:
runs-on: ubuntu-latest
steps:
- name: Release Drafter
uses: release-drafter/release-drafter@v5.7.0
with:
config-name: ./.github/release-drafter.yml
env:
GITHUB_TOKEN: ${{ secrets.ACCESS_TOKEN }}
53 changes: 53 additions & 0 deletions .gitpod.Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
#!/bin/echo docker build . -f
# -*- coding: utf-8 -*-

FROM gitpod/workspace-full:latest

ARG BUILD_DATE="$(git rev-parse --short HEAD)"
ARG VCS_REF="$(date -u +\"%Y-%m-%dT%H:%M:%SZ\")"
ARG VERSION="1.0.0"

LABEL maintainer="Alexander Rogalskiy <hi@nullables.io>"
LABEL organization="nullables.io"
LABEL io.nullables.api.playground.image.build-date=$BUILD_DATE
LABEL io.nullables.api.playground.image.name="StyleGrams"
LABEL io.nullables.api.playground.image.description="Styled infographics"
LABEL io.nullables.api.playground.image.url="https://nullables.io/"
LABEL io.nullables.api.playground.image.vcs-ref=$VCS_REF
LABEL io.nullables.api.playground.image.vcs-url="https://github.com/AlexRogalskiy/stylegrams"
LABEL io.nullables.api.playground.image.vendor="Nullables.io"
LABEL io.nullables.api.playground.image.version=$VERSION

ENV LC_ALL en_US.UTF-8
ENV LANG ${LC_ALL}
ENV HOME /home/gitpod

# Define a constant with the working directory
ARG USER_HOME_DIR="/root"

RUN apt-get update && \
apt-get -y install \
libgtkextra-dev \
libgconf2-dev \
libnss3 \
libasound2 \
libxtst-dev \
libxss1 \
libxss-dev \
software-properties-common \
build-essential \
xvfb \
curl \
libgtk-3-0 \
unzip

RUN curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | apt-key add -
RUN echo "deb https://dl.yarnpkg.com/debian/ stable main" | tee /etc/apt/sources.list.d/yarn.list

RUN curl -sL https://deb.nodesource.com/setup_10.x | bash -

RUN apt-get update && apt-get -y install yarn nodejs

USER gitpod

WORKDIR $HOME
25 changes: 25 additions & 0 deletions .gitpod.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
github:
prebuilds:
# enable for the master/default branch (defaults to true)
master: true
# enable for all branches in this repo (defaults to false)
branches: true
# add a "Review in Gitpod" button as a comment to pull requests (defaults to false)
addComment: false
# add a "Review in Gitpod" button to the pull request's description (defaults to false)
addBadge: false
# add a label once the prebuild is ready to pull requests (defaults to false)
addLabel: false
# enable for pull requests coming from this repo (defaults to true)
pullRequests: true
# enable for pull requests coming from forks (defaults to false)
pullRequestsFromForks: true
# add a check to pull requests (defaults to true)
addCheck: true

tasks:
- before: yarn --version
command: yarn install && yarn run all && yarn run test:all

image:
file: .gitpod.Dockerfile
39 changes: 39 additions & 0 deletions .mega-linter.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Configuration file for Mega-Linter
# See all available variables at https://nvuillam.github.io/mega-linter/configuration/ and in linters documentation

APPLY_FIXES: all # When active, APPLY_FIXES must also be defined as environment variable (in github/workflows/mega-linter.yml or other CI tool)
# ENABLE: # If you use ENABLE variable, all other languages/formats/tooling formats will be disabled by default
# ENABLE_LINTERS: # If you use ENABLE_LINTERS variable, all other linters will be disabled by default
ENABLE:
- DOCKERFILE
- MARKDOWN
- YAML
- TYPESCRIPT
- JAVASCRIPT
- JSON
- EDITORCONFIG
DISABLE_LINTERS:
- JAVASCRIPT_STANDARD
- TYPESCRIPT_STANDARD
FILTER_REGEX_EXCLUDE: '(\.automation/test|\.automation/generated|docs/javascripts|docs/overrides|docs/json-schemas|flavors|clj-kondo|TEMPLATES)'
YAML_YAMLLINT_FILTER_REGEX_EXCLUDE: '(templates/\.mega-linter\.yml)'
YAML_PRETTIER_FILTER_REGEX_EXCLUDE: '(templates/\.mega-linter\.yml|mkdocs\.yml)'
YAML_V8R_FILTER_REGEX_EXCLUDE: '(descriptors|templates/\.mega-linter\.yml)'
BASH_FILTER_REGEX_EXCLUDE: '(lib)'
MARKDOWN_FILTER_REGEX_EXCLUDE: '(license\.md)'
MARKDOWN_MARKDOWN_LINK_CHECK_DISABLE_ERRORS: true
SPELL_MISSPELL_FILTER_REGEX_EXCLUDE: '(\.automation/generated|docs/descriptors)'
DOCKERFILE_HADOLINT_ARGUMENTS:
'--ignore DL3003 --ignore DL3007 --ignore DL3013 --ignore DL3016 --ignore DL3018 --ignore DL3028 --ignore
DL4001 --ignore DL4006 --ignore SC2015 --ignore SC2016 --ignore SC2039 --ignore SC2086 --ignore SC1091'
SHOW_ELAPSED_TIME: true
EMAIL_REPORTER_EMAIL: hi@nullables.io
FILEIO_REPORTER: true
PLUGINS:
- https://raw.githubusercontent.com/nvuillam/mega-linter/master/.automation/test/mega-linter-plugin-test/test.megalinter-descriptor.yml
PRE_COMMANDS:
- command: echo "This is Mega-Linter PRE_COMMAND on own Mega-Linter ! :)"
cwd: 'root'
POST_COMMANDS:
- command: echo "This is Mega-Linter POST_COMMAND on own Mega-Linter ! :)"
cwd: 'workspace'
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@
[![CI](https://github.com/AlexRogalskiy/stylegrams/workflows/CI/badge.svg)](https://github.com/AlexRogalskiy/stylegrams/workflows/CI)
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
[![GitHub Super-Linter](https://github.com/AlexRogalskiy/stylegrams/workflows/Lint%20Code%20Base/badge.svg)](https://github.com/marketplace/actions/super-linter)
[![Mega-Linter](https://github.com/AlexRogalskiy/stylegrams/workflows/Mega-Linter/badge.svg?branch=master)](https://github.com/AlexRogalskiy/stylegrams/actions?query=workflow%3AMega-Linter+branch%3Amaster)
[![BCH compliance](https://bettercodehub.com/edge/badge/AlexRogalskiy/stylegrams?branch=master)](https://bettercodehub.com/)

## *Table of contents*

Expand All @@ -54,6 +56,7 @@
- [*Acknowledgement*](#acknowledgement)
- [*Forks*](#forks)
- [*Issues*](#issues)
- [*Team Tools*](#team-tools)
- [*Development Support*](#development-support)

## *Description*
Expand Down Expand Up @@ -137,6 +140,16 @@ See also the list of [contributors][contributors] who participated in this proje

[![issuehunt-to-marktext](https://issuehunt.io/static/embed/issuehunt-button-v1.svg)](https://issuehunt.io/r/AlexRogalskiy/stylegrams)

## *Team Tools*

[![alt tag](http://pylonsproject.org/img/logo-jetbrains.png)](https://www.jetbrains.com/)

***StyleGrams*** Team would like inform that JetBrains is helping by provided IDE to develop the application. Thanks to its support program for an Open Source projects!

[![Edit with Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/AlexRogalskiy/stylegrams)

***StyleGrams*** has experimental support for Gitpod, a pre-configured development environment that runs in your browser. To use Gitpod, click the button below and sign in with GitHub. Gitpod also offers a browser add-on, though it is not required.

## *Development Support*

Like ***StyleGrams*** ? Consider buying me a coffee :)
Expand Down
37 changes: 37 additions & 0 deletions docker/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
FROM ubuntu:latest

RUN apt-get update && \
apt-get -y install \
libgtkextra-dev \
libgconf2-dev \
libnss3 \
libasound2 \
libxtst-dev \
libxss1 \
libxss-dev \
software-properties-common \
build-essential \
xvfb \
curl \
libgtk-3-0 \
unzip

RUN curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | apt-key add -
RUN echo "deb https://dl.yarnpkg.com/debian/ stable main" | tee /etc/apt/sources.list.d/yarn.list

RUN curl -sL https://deb.nodesource.com/setup_10.x | bash -

RUN apt-get update && \
apt-get -y install yarn nodejs

RUN mkdir -p /app
WORKDIR /app
COPY . /app

# we could run yarn to compile everything, but the
# test lib does that too so don't bother
RUN yarn

# docker build -t before-dawn . && docker run -it -v $PWD:/app before-dawn bash
# docker run -it before-dawn yarn test
# tail -f ~/.config/Electron/log.log

0 comments on commit ee668cd

Please sign in to comment.