Skip to content

Commit

Permalink
Add boilerplate
Browse files Browse the repository at this point in the history
  • Loading branch information
rashil2000 committed Dec 27, 2021
1 parent 93e1c5d commit 7e2900a
Show file tree
Hide file tree
Showing 25 changed files with 322 additions and 0 deletions.
20 changes: 20 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# EditorConfig (is awesome): http://EditorConfig.org

# * top-most EditorConfig file
root = true

# default style settings
[*]
charset = utf-8
end_of_line = crlf
indent_size = 4
indent_style = space
insert_final_newline = true
trim_trailing_whitespace = true

[*.{yml,yaml}]
indent_size = 2

[*.{[Bb][Aa][Tt],[Cc][Mm][Dd]}]
# DOS/Win *requires* BAT/CMD files to have CRLF newlines
end_of_line = crlf
2 changes: 2 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# retain windows line-endings in case checked out on mac or linux
* text eol=crlf
49 changes: 49 additions & 0 deletions .github/ISSUE_TEMPLATE/Bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
name: "Bug Report"
about: "I am facing some problems."
title: ""
labels: "bug"
---

<!--
By opening this issue you confirm that you have searched for similar issues/PRs here already.
Failing to do so will most likely result in closing of this issue without any explanation.
Incomplete form details below might also result in closing of the issue.
-->

## Bug Report

**Package Name:** [name of package which has bug(s)]

### Current Behaviour

<!-- A clear and concise description of the behaviour. -->

### Expected Behaviour

<!-- A clear and concise description of what you expected to happen. -->

### Additional context/output

<!-- Add any other context about the problem here. If applicable, paste terminal output here to help explain. -->

### Possible Solution

<!--- Only if you have suggestions on a fix for the bug -->

### System details

**Windows version:** [e.g. 7, 8, 10]

**OS architecture:** [e.g. 32bit, 64bit]

**PowerShell version:** [output of `"$($PSVersionTable.PSVersion)"`]

**Additional software:** [(optional) e.g. ConEmu, Git]

#### Scoop Configuration
<!-- Can be found in ~/.config/scoop/config.json -->

```json
//# Your configuration here
```
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/Package_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
name: "Package Request"
about: "I have a suggestion for a package (and may want to implement it)!"
title: "[Request] "
labels: "package-request"
---

<!--
By opening this issue you confirm that you have searched for similar issues/PRs here already.
Failing to do so will most likely result in closing of this issue without any explanation.
Incomplete form details below might also result in closing of the issue.
-->

## Package Request

### Information

**Name:** [name of new package]

**Description:** [clear and concise details of what it is]

**Homepage:** [a URL/link]

**Download link(s):** [URL(s)/link(s)]

**Some indication of popularity/repute:** [GitHub stars/software reviews etc.]

12 changes: 12 additions & 0 deletions .github/issue_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@

<!--
By opening this issue you confirm that you have searched for similar issues/PRs here already.
Failing to do so will most likely result in closing of this issue without any explanation.
-->

#### Scoop Configuration
<!-- Can be found in ~/.config/scoop/config.json -->

```json
//# Your configuration here
```
15 changes: 15 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<!-- Provide a general summary of your changes in the title above -->

<!--
By opening this PR you confirm that you have searched for similar issues/PRs here already.
Failing to do so will most likely result in closing of this PR without any explanation.
It is also mandatory to open a relevant issue (either Package Request or Bug Report) for
discussion with the maintainers, before creating any new PR.
Read the contributing guide first to save both your and our time.
-->

Closes #XXXX
<!-- or -->
Relates to #XXXX

- [ ] I have read the [Contributing Guide](https://github.com/ScoopInstaller/.github/blob/main/.github/CONTRIBUTING.md).
17 changes: 17 additions & 0 deletions .github/workflows/excavator.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
on:
workflow_dispatch:
schedule:
# run every 4 hours
- cron: '20 */4 * * *'
name: Excavator
jobs:
excavate:
name: Excavate
runs-on: windows-latest
steps:
- uses: actions/checkout@main
- name: Excavate
uses: ScoopInstaller/GithubActions@main
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
SKIP_UPDATED: '1'
15 changes: 15 additions & 0 deletions .github/workflows/issue_comment.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
on:
issue_comment:
types: [ created ]
name: Commented Pull Request
jobs:
pullRequestHandler:
name: PullRequestHandler
runs-on: windows-latest
steps:
- uses: actions/checkout@main
- name: PullRequestHandler
uses: ScoopInstaller/GithubActions@main
if: startsWith(github.event.comment.body, '/verify')
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
15 changes: 15 additions & 0 deletions .github/workflows/issues.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
on:
issues:
types: [ opened, labeled ]
name: Issues
jobs:
issueHandler:
name: IssueHandler
runs-on: windows-latest
steps:
- uses: actions/checkout@main
- name: IssueHandler
uses: ScoopInstaller/GithubActions@main
if: github.event.action == 'opened' || (github.event.action == 'labeled' && contains(github.event.issue.labels.*.name, 'verify'))
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
14 changes: 14 additions & 0 deletions .github/workflows/pull_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
on:
pull_request:
types: [ opened ]
name: Pull Requests
jobs:
pullRequestHandler:
name: PullRequestHandler
runs-on: windows-latest
steps:
- uses: actions/checkout@main
- name: PullRequestHandler
uses: ScoopInstaller/GithubActions@main
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
*.sublime-workspace
*~
._*
page.html
checkver-*.html
6 changes: 6 additions & 0 deletions .markdownlint.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"MD013": false,
"MD024": {
"siblings_only": true
}
}
6 changes: 6 additions & 0 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"recommendations": [
"EditorConfig.EditorConfig",
"ms-vscode.PowerShell"
]
}
26 changes: 26 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
// Configure PSScriptAnalyzer settings
{
"[powershell]": {
"editor.formatOnSave": true
},
"powershell.scriptAnalysis.settingsPath": "PSScriptAnalyzerSettings.psd1",
"powershell.codeFormatting.preset": "OTBS",
"powershell.codeFormatting.alignPropertyValuePairs": true,
"powershell.codeFormatting.ignoreOneLineBlock": true,
"json.schemas": [
{
"url": "https://raw.githubusercontent.com/ScoopInstaller/Scoop/master/schema.json",
"fileMatch": [
"bucket/*.json"
]
}
],
"files.exclude": {
"**/.git": true,
"**/.svn": true,
"**/.hg": true,
"**/CVS": true,
"**/.DS_Store": true,
"**/tmp": true
}
}
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Scoop Bucket Template

Template bucket for [Scoop](https://scoop.sh), the Windows command-line installer.

How do I install these manifests?
---------------------------------

To add this bucket, run `scoop bucket add <bucketname> https://github.com/<username>/<bucketname>`. To install, do `scoop install <manifest>`.

How do I contribute new manifests?
----------------------------------

To make a new manifest conribution, please read the [Contributing Guide](https://github.com/ScoopInstaller/.github/blob/main/.github/CONTRIBUTING.md).

----

#### To use this template

- Modify the Readme.md and the bin/auto-pr.ps1 files accordingly.
- Enable GitHub Actions for this repository.
- Login to AppVeyor and import this repository.
39 changes: 39 additions & 0 deletions appveyor.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
version: "{build}-{branch}"
branches:
except:
- gh-pages
build: off
deploy: off
clone_depth: 2
image: Visual Studio 2019
environment:
scoop: C:\projects\scoop
scoop_home: C:\projects\scoop
scoop_helpers: C:\projects\helpers
lessmsi: '%scoop_helpers%\lessmsi\lessmsi.exe'
innounp: '%scoop_helpers%\innounp\innounp.exe'
matrix:
- PowerShell: 5
- PowerShell: Current
cache:
- '%USERPROFILE%\Documents\WindowsPowerShell\Modules -> appveyor.yml'
- C:\projects\helpers -> appveyor.yml, test\bin\*.ps1
matrix:
fast_finish: true
init:
- ps: if(!(Test-Path "$env:SCOOP")) { git clone -q --depth=1 "https://github.com/ScoopInstaller/Scoop" "$env:SCOOP" }
for:
- matrix:
only:
- PowerShell: 5
install:
- ps: . "$env:SCOOP_HOME\test\bin\init.ps1"
test_script:
- ps: . "$env:SCOOP_HOME\test\bin\test.ps1" -TestPath "$env:APPVEYOR_BUILD_FOLDER"
- matrix:
only:
- PowerShell: Current
install:
- pwsh: . "$env:SCOOP_HOME\test\bin\init.ps1"
test_script:
- pwsh: . "$env:SCOOP_HOME\test\bin\test.ps1" -TestPath "$env:APPVEYOR_BUILD_FOLDER"
9 changes: 9 additions & 0 deletions bin/auto-pr.ps1
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
param(
# overwrite upstream param
[String]$upstream = "<username>/<bucketname>:main"
)

if(!$env:SCOOP_HOME) { $env:SCOOP_HOME = Resolve-Path (scoop prefix scoop) }
$autopr = "$env:SCOOP_HOME/bin/auto-pr.ps1"
$dir = "$psscriptroot/../bucket" # checks the parent dir
Invoke-Expression -command "& '$autopr' -dir '$dir' -upstream $upstream $($args | ForEach-Object { "$_ " })"
4 changes: 4 additions & 0 deletions bin/checkurls.ps1
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
if(!$env:SCOOP_HOME) { $env:SCOOP_HOME = Resolve-Path (scoop prefix scoop) }
$checkurls = "$env:SCOOP_HOME/bin/checkurls.ps1"
$dir = "$psscriptroot/../bucket" # checks the parent dir
Invoke-Expression -command "& '$checkurls' -dir '$dir' $($args | ForEach-Object { "$_ " })"
4 changes: 4 additions & 0 deletions bin/checkver.ps1
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
if(!$env:SCOOP_HOME) { $env:SCOOP_HOME = Resolve-Path (scoop prefix scoop) }
$checkver = "$env:SCOOP_HOME/bin/checkver.ps1"
$dir = "$psscriptroot/../bucket" # checks the parent dir
Invoke-Expression -command "& '$checkver' -dir '$dir' $($args | ForEach-Object { "$_ " })"
4 changes: 4 additions & 0 deletions bin/formatjson.ps1
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
if(!$env:SCOOP_HOME) { $env:SCOOP_HOME = Resolve-Path (scoop prefix scoop) }
$formatjson = "$env:SCOOP_HOME/bin/formatjson.ps1"
$path = "$psscriptroot/../bucket" # checks the parent dir
Invoke-Expression -command "& '$formatjson' -dir '$path' $($args | ForEach-Object { "$_ " })"
4 changes: 4 additions & 0 deletions bin/missing-checkver.ps1
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
if(!$env:SCOOP_HOME) { $env:SCOOP_HOME = Resolve-Path (scoop prefix scoop) }
$missing_checkver = "$env:SCOOP_HOME/bin/missing-checkver.ps1"
$dir = "$psscriptroot/../bucket" # checks the parent dir
Invoke-Expression -command "& '$missing_checkver' -dir '$dir' $($args | ForEach-Object { "$_ " })"
2 changes: 2 additions & 0 deletions bin/test.ps1
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
if(!$env:SCOOP_HOME) { $env:SCOOP_HOME = Resolve-Path (scoop prefix scoop) }
Invoke-Pester "$psscriptroot/.."
2 changes: 2 additions & 0 deletions bucket/.gitkeep
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# This directory stores all the JSON manifests.
# Delete this '.gitkeep' file once this directory has any files.
2 changes: 2 additions & 0 deletions deprecated/.gitkeep
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# This directory stores all the deprecated JSON manifests, which are not meant to be installed.
# Delete this '.gitkeep' file once this directory has any files.
2 changes: 2 additions & 0 deletions scripts/.gitkeep
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# This directory stores helper files like shell scripts, registry entries etc. for installable applications.
# Delete this '.gitkeep' file once this directory has any files.

0 comments on commit 7e2900a

Please sign in to comment.