Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DELETE THIS REPOSITORY #2

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
/checkver*
/.cache/
/.vagrant/
14 changes: 7 additions & 7 deletions .vscode/Template.jsonc
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,12 @@
"singlebinary.exe",
"withOtherName",
"andSomeArguments"
]
],
"shortcuts": [ // Array Of Array Of Strings (similar to bin)
[
"file.exe",
"Shortcut Name"
],
[
"singlebinary.exe",
Expand All @@ -94,12 +100,6 @@
"withOtherIcon.ico"
]
],
"shortcuts": [ // String or Array Of Array Of Strings (similar to bin)
[
"",
""
]
],
"psmodule": {
"name": "moduleName"
},
Expand All @@ -123,7 +123,7 @@
},
"autoupdate": {
"url": "https://ash258.com#/newName.zip",
"hash": { // Some vendors do not ship hashes 😭
"hash": { // Some vendors do not ship hashes
"url": "https://ash258.com",
"regex": "do not write regexes for hash algorithms, use variables ($md5, $sha1, $sha256, $sha512, $checksum)"
},
Expand Down
7 changes: 5 additions & 2 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
{
"recommendations": [
"CoenraadS.bracket-pair-colorizer-2",
"DavidAnson.vscode-markdownlint",
"EditorConfig.EditorConfig",
"ms-vscode.PowerShell",
"fabiospampinato.vscode-terminals",
"usernamehw.errorlens",
"ms-vscode.powershell-preview",
"redhat.vscode-yaml",
"usernamehw.errorlens",
"yzhang.markdown-all-in-one",
],
}
13 changes: 11 additions & 2 deletions .vscode/json.code-snippets
Original file line number Diff line number Diff line change
Expand Up @@ -95,10 +95,19 @@
"body": [
"\"\\$file = '$1'\",",
"\"if (!(Test-Path \\\"\\$persist_dir\\\\\\\\\\$file\\\")) {\",",
"\"\tWrite-Host 'File' \\$file 'does not exists. Creating.' -f Yellow\",",
"\"\t\\$CONT = @('$2')\",",
"\"\tSet-Content \\\"\\$dir\\\\\\\\\\$file\\\" (\\$CONT -join \\\"`r`n\\\") -Encoding Ascii\",",
"\"\tSet-Content \\\"\\$dir\\\\\\\\\\$file\\\" $CONT -Encoding Ascii\",",
"\"}\"",
],
},
"Inline persist check (With content)": {
"prefix": "persistInlineContent",
"scope": "json,jsonc",
"body": "\"if (! (Test-Path \\\"\\$persist_dir\\\\\\\\$1\\\")) { Set-Content \\\"\\$dir\\\\\\\\$1\\\" $2 -Encoding Ascii }\",",
},
"Inline persist check (without content)": {
"prefix": "persistInlineNoContent",
"scope": "json,jsonc",
"body": "\"if (! (Test-Path \\\"\\$persist_dir\\\\\\\\$1\\\")) { New-Item \\\"\\$dir\\\\\\\\$1\\\" | Out-Null }\",",
},
}
23 changes: 13 additions & 10 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,6 @@
},
],
"powershell.codeFormatting.preset": "OTBS",
"yaml.format.bracketSpacing": true,
"yaml.format.enable": true,
"yaml.format.singleQuote": true,
"yaml.validate": true,
"yaml.schemas": {
"http://json.schemastore.org/appveyor": "appveyor.yml",
"https://raw.githubusercontent.com/lukesampson/scoop/master/schema.json": [
"bucket/*.yml",
],
},
"terminals.terminals": [
{
"name": "Powershell",
Expand Down Expand Up @@ -51,4 +41,17 @@
"open": true,
},
],
"yaml.format.bracketSpacing": true,
"yaml.format.enable": true,
"yaml.format.singleQuote": true,
"yaml.validate": true,
"yaml.schemas": {
"https://raw.githubusercontent.com/SchemaStore/schemastore/master/src/schemas/json/appveyor.json": "appveyor.yml",
"https://raw.githubusercontent.com/lukesampson/scoop/master/schema.json": [
"bucket/*.yml",
],
"https://raw.githubusercontent.com/SchemaStore/schemastore/master/src/schemas/json/github-workflow.json": [
".github/workflows/*",
],
},
}
1 change: 1 addition & 0 deletions DELETE THIS REPO
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
DELETE THIS REPOSITORY AND ADOPT IT USING TEMPLATE
22 changes: 17 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,21 @@

In this repository you will find everything you need to know about creating custom bucket with appveyor support.

- [Files and helpers](#files-and-helpers)
- [`bucket` Folder](#bucket-folder)
- [`bin` Folder](#bin-folder)
- [`Bucket.Tests.ps1` File](#buckettestsps1-file)
- [`.vscode` Folder](#vscode-folder)
- [`.github` Folder](#github-folder)
- [`config files`](#config-files)
- [How to use and adopt this bucket](#how-to-use-and-adopt-this-bucket)

## Files and helpers

### `bucket` Folder

- All manifests belong here
- `.gitkeep` file could be removed after you push your first manifest
- `.gitkeep` file could be removed when you push your first manifest

### `bin` Folder

Expand Down Expand Up @@ -44,7 +53,7 @@ Contains all syntax highlighting, code formating, manifest creating tools you co
- Create only architecture property with 64bit and 32bit
- `upAr`
- Create autoupdate property with architecture
- `persistCheck`
- `persistCheck`, `persistInlineContent`, `persistInlineNoContent`
- Installer / pre_install script for checking if file is already persisted or need to be created

### `.github` Folder
Expand All @@ -53,7 +62,7 @@ GitHub repository configuration.

- `workflows` folder
- Linux (legacy) version [GitHub Actions](https://github.com/features/actions) configuration for automatic issue/PR/updates handling.
- Windows version of actions could be used for better and future proof implementation (see <https://github.com/Ash258/Scoop-GithubActions/tree/master-win> for updated configs)
- Windows version of actions could be used for better and future proof implementation (see <https://github.com/Ash258/Scoop-GithubActions/tree/main-win> for updated configs)
- `CODEOWNERS`
- Pull requests will request review for users defined in this file
- `PULL REQUEST TEMPLATE`
Expand Down Expand Up @@ -96,10 +105,12 @@ GitHub repository configuration.
- Only master branch is better, since you can freely test in other branches and do not mystificate users
- [You could use alternative styles](https://shields.io/category/build#styles)
1. Clone project into some folder
- `git clone [email protected]:USER/REPO.git MyAwesomeBucket`
- or
- `git clone https://github.com/USER/REPO.git MyAwesomeBucket`
1. Open vscode with this clone
- `code MyAwesomeBucket`
1. Configure remote repository
1. _[optional]_ Configure remote repository
1. `git remote add 'upstream' 'https://github.com/Ash258/GenericBucket.git'`
- This step will allow you to synchronize changes with this template repository
- If some changes are pushed into this repository and you want to reflect them into your bucket, you can simply do something like:
Expand All @@ -108,6 +119,7 @@ GitHub repository configuration.
- Do changes
- `git merge master` or create PR in github
1. Create proper README.md
1. [Open this README in the browser for reference](https://github.com/Ash258/GenericBucket/tree/master/README.md)
1. Open `README.template.md`
1. Replace all `%%templatestring%%` with real and according values
1. Replace appveyor status badge with yours
Expand All @@ -119,4 +131,4 @@ GitHub repository configuration.
1. Actions
1. Open each file in `.github\workflows` and change `[email protected]` with your email
1. Visit <https://github.com/Ash258/Scoop-GithubActions> for more information
1. 🎉🎉 Everything set. High Quality bucket is ready for new users 🎉🎉
1. 🎉🎉 Everything set. High quality and automated bucket is ready for new users 🎉🎉