From 3d544a6a01f61fe481d7447b18c532ab66dc328b Mon Sep 17 00:00:00 2001 From: Pietro Passarelli Date: Mon, 23 Sep 2019 11:30:21 +0100 Subject: [PATCH] removed github action and added PR and issues templates as well as docs folder template --- .DS_Store | Bin 0 -> 6148 bytes .github/ISSUE_TEMPLATE/bug_report.md | 38 ++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 +++ .github/ISSUE_TEMPLATE/question.md | 10 ++ .github/PULL_REQUEST_TEMPLATE.md | 12 ++ .github/workflows/electro.yml | 19 -- docs/.keep | 0 docs/ADR/ADR-Template.md | 72 ++++++++ docs/guides/.keep | 0 package.json | 210 ++++++++++++---------- 10 files changed, 270 insertions(+), 111 deletions(-) create mode 100644 .DS_Store create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/question.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/electro.yml create mode 100644 docs/.keep create mode 100644 docs/ADR/ADR-Template.md create mode 100644 docs/guides/.keep diff --git a/.DS_Store b/.DS_Store new file mode 100644 index 0000000000000000000000000000000000000000..62b72ec08fe29328124099bb74c6c9dea2407fb1 GIT binary patch literal 6148 zcmeHK!AiqG5Z!I7CWx4Wpx*Z4t%n9n>qQ8$9=r(=J*cz^DK-!jX;O>UNWMe=$RF@` zoY~zLOBFnc*qJcg8zk>eb}IJ*nt zG=TowLNq!4A_MsDYAj?C%UJ&T{RMY%l;w@aJFir0E30dU3D1Uc?G4hgm;3oBbN%5Z z_D=nL5NP`>P2-vE2j@|L+_koj(j@nzq(79&QP_u&tBWWJ)3KY5k}#9=cxnLGF}v38 zWMa3P&APA;+C^PV+U-VNH1}IYVH(?e_TfqI_Th2zR6M^ZS~+}yQZ_YC;T4Qoh460hI!Nfd-(Xu~Y~i5c(02G*Ckf{3-(<>Tgi^ literal 0 HcmV?d00001 diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..428fc4a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,38 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: bug +assignees: + +--- + +**Describe the bug** + + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** + + +**Screenshots** + + +**Desktop (please complete the following information):** + - OS: [e.g. iOS] + - Browser [e.g. chrome, safari] + - Version [e.g. 22] + +**Smartphone (please complete the following information):** + - Device: [e.g. iPhone6] + - OS: [e.g. iOS8.1] + - Browser [e.g. stock browser, safari] + - Version [e.g. 22] + +**Additional context** + \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..af8a9f5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: Enhancement +assignees: + +--- + +**Is your feature request related to a problem? Please describe.** + + +**Describe the solution you'd like** + + +**Describe alternatives you've considered** + + +**Additional context** + \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 0000000..3b27c7f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,10 @@ +--- +name: Question +about: Ask a question about this project +title: '' +labels: bug +assignees: + +--- + + \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..7b1593b --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,12 @@ +**Is your Pull Request request related to another issue in this repository ?** + + +**Describe what the PR does** + + + +**State whether the PR is ready for review or whether it needs extra work** + + +**Additional context** + \ No newline at end of file diff --git a/.github/workflows/electro.yml b/.github/workflows/electro.yml deleted file mode 100644 index 3680902..0000000 --- a/.github/workflows/electro.yml +++ /dev/null @@ -1,19 +0,0 @@ -name: Electron - -on: - push: - tags: - - 'v*.*.*' - -jobs: - build: - runs-on: macOS-10.14 - steps: - - name: Checkout - uses: actions/checkout@v1 - - name: Build - run: npm install - - name: Publish - run: npm run build:m:publish:always - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/docs/.keep b/docs/.keep new file mode 100644 index 0000000..e69de29 diff --git a/docs/ADR/ADR-Template.md b/docs/ADR/ADR-Template.md new file mode 100644 index 0000000..0b31f89 --- /dev/null +++ b/docs/ADR/ADR-Template.md @@ -0,0 +1,72 @@ +# [short title of solved problem and solution] + +* Status: [accepted | superseded by [ADR-0005](0005-example.md) | deprecated | …] +* Deciders: [list everyone involved in the decision] +* Date: [YYYY-MM-DD when the decision was last updated] + +Technical Story: [description | ticket/issue URL] + +## Context and Problem Statement + +[Describe the context and problem statement, e.g., in free form using two to three sentences. You may want to articulate the problem in form of a question.] + +## Decision Drivers + +* [driver 1, e.g., a force, facing concern, …] +* [driver 2, e.g., a force, facing concern, …] +* … + +## Considered Options + +* [option 1] +* [option 2] +* [option 3] +* … + +## Decision Outcome + +Chosen option: "[option 1]", because [justification. e.g., only option, which meets k.o. criterion decision driver | which resolves force force | … | comes out best (see below)]. + +### Positive Consequences + +* [e.g., improvement of quality attribute satisfaction, follow-up decisions required, …] +* … + +### Negative consequences + +* [e.g., compromising quality attribute, follow-up decisions required, …] +* … + +## Pros and Cons of the Options + +### [option 1] + +[example | description | pointer to more information | …] + +* Good, because [argument a] +* Good, because [argument b] +* Bad, because [argument c] +* … + +### [option 2] + +[example | description | pointer to more information | …] + +* Good, because [argument a] +* Good, because [argument b] +* Bad, because [argument c] +* … + +### [option 3] + +[example | description | pointer to more information | …] + +* Good, because [argument a] +* Good, because [argument b] +* Bad, because [argument c] +* … + +## Links + +* [Link type] [Link to ADR] +* … \ No newline at end of file diff --git a/docs/guides/.keep b/docs/guides/.keep new file mode 100644 index 0000000..e69de29 diff --git a/package.json b/package.json index 95a39a6..812704c 100644 --- a/package.json +++ b/package.json @@ -1,99 +1,125 @@ { - "name": "video-downloader", - "version": "1.0.4", - "description": "A minimal Electron application to download videos, eg from youtube", - "main": "main.js", - "scripts": { - "start": "electron .", - "pack": "build --dir", - "pack:mac": "build --dir --mac --x64", - "pack:linux": "build --dir --linux --x64", - "pack:win": "build --dir --win --x64", - "build": "build", - "build:mac": "build --mac --x64", - "build:mac_app_store": "echo 'Mac App Store Option Not currently implemented'", - "build:win": "build --win nsis-web --x64", - "build:linux": "build --linux --x64" - }, - "repository": "https://github.com/electron/electron-quick-start", - "keywords": [ - "Electron", - "video", - "github", - "youtube", - "downloader", - "os x" - ], - "build": { - "appId": "org.video.downaloader", - "asar": false, - "files": [ - "**/*" - ], - "copyright": "2017 Pietro Passarelli", - "mac": { - "category": "public.app-category.productivity", - "files": [] - }, - "linux": { - "category": "", - "packageCategory": "GNOME;GTK;VideoEditing;PaperEditing;Transcriptions", - "description": "video download Desktop Client for Linux", - "target": [ - "deb", - "zip", - "AppImage", - "rpm" - ], - "maintainer": "Pietro Passarelli ", - "files": [] - }, - "deb": { - "synopsis": "Video downaloader" + "name": "video-downloader", + "version": "1.0.5", + "description": "A minimal Electron application to download videos, eg from youtube", + "main": "main.js", + "scripts": { + "start": "electron .", + "pack": "build --dir", + "pack:mac": "build --dir --mac --x64", + "pack:linux": "build --dir --linux --x64", + "pack:win": "build --dir --win --x64", + "build": "build", + "build:mac": "build --mac --x64", + "build:mac_app_store": "echo 'Mac App Store Option Not currently implemented'", + "build:win": "build --win nsis-web --x64", + "build:linux": "build --linux --x64", + "build:m:publish:always": "electron-builder -m --publish always" }, - "dmg": { - "background": "build/background.png", - "icon": "build/icon.icns", - "iconSize": 128, - "contents": [ - { - "x": 448, - "y": 340, - "type": "link", - "path": "/Applications" + "repository": "https://github.com/electron/electron-quick-start", + "keywords": [ + "Electron", + "video", + "github", + "youtube", + "downloader", + "os x" + ], + "build": { + "publish": { + "provider": "github", + "releaseType": "prerelease", + "vPrefixedTagName": false, + "owner": "pietrop", + "repo": "electron-video-downloader" + }, + "appId": "org.video.downaloader", + "asar": false, + "directories": { + "buildResources": "assets" + }, + "files": [ + "**/*", + "build/**", + "!config/", + "!assets/", + "!spec/", + "!project_page/", + "!vendor/", + "!docs/", + "!dist/", + "!icons/", + "node_modules/**/*" + ], + "copyright": "2017 Pietro Passarelli", + "mac": { + "category": "public.app-category.productivity", + "files": [], + "target": [{ + "target": "dmg", + "arch": [ + "x64" + ] + }] + }, + "linux": { + "category": "", + "packageCategory": "GNOME;GTK;VideoEditing;PaperEditing;Transcriptions", + "description": "video download Desktop Client for Linux", + "target": [ + "deb", + "zip", + "AppImage", + "rpm" + ], + "maintainer": "Pietro Passarelli ", + "files": [] + }, + "deb": { + "synopsis": "Video downaloader" + }, + "dmg": { + "background": "build/background.png", + "icon": "build/icon.icns", + "iconSize": 128, + "contents": [{ + "x": 448, + "y": 340, + "type": "link", + "path": "/Applications" + }, + { + "x": 192, + "y": 340, + "type": "file" + } + ] + }, + "win": { + "target": "nsis", + "icon": "build/icon.ico", + "files": [ + "node_modules/ffmpeg-static/bin/win/${arch}/ffmpeg", + "!node_modules/ffmpeg-static/bin/win/ia32${/*}", + "!node_modules/ffmpeg-static/bin/linux${/*}", + "!node_modules/ffmpeg-static/bin/mac${/*}" + ] }, - { - "x": 192, - "y": 340, - "type": "file" + "nsis": { + "perMachine": true, + "oneClick": false } - ] }, - "win": { - "target": "nsis", - "icon": "build/icon.ico", - "files": [ - "node_modules/ffmpeg-static/bin/win/${arch}/ffmpeg", - "!node_modules/ffmpeg-static/bin/win/ia32${/*}", - "!node_modules/ffmpeg-static/bin/linux${/*}", - "!node_modules/ffmpeg-static/bin/mac${/*}" - ] + "author": "Pietro Passarelli (http://pietropassarelli.com)", + "license": "MIT", + "devDependencies": { + "electron": "^5.0.3", + "electron-builder": "^20.43.0" }, - "nsis": { - "perMachine": true, - "oneClick": false + "dependencies": { + "iso-639-1": "^2.0.3", + "node-webvtt-youtube": "^1.0.0", + "path": "^0.12.7", + "youtube-dl": "^1.12.2" } - }, - "author": "Pietro Passarelli (http://pietropassarelli.com)", - "license": "MIT", - "devDependencies": { - "electron": "^5.0.3", - "electron-builder": "^20.43.0" - }, - "dependencies": { - "iso-639-1": "^2.0.3", - "node-webvtt-youtube": "^1.0.0", - "path": "^0.12.7", - "youtube-dl": "^1.12.2" - } -} +} \ No newline at end of file