For information about lc_
software, see here.
❗❗🎉 Repository was converted into Template. See blog for more information. 🎉❗❗
In this repository you will find everything you need to know about creating custom bucket with appveyor support.
- All manifests belong here
.gitkeep
file could be removed after you push your first manifest
Scripts which will save you time while debuging and writing manifests.
If you need help how to use them just run Get-Help .\bin\<BINARY>.ps1
.
- Test which are executed inside Appveyor pipeline
- Could be configured as
pre_commit
hook
Contains all syntax highlighting, code formating, manifest creating tools you could use.
- Extensions
- All extensions which will save your time while writing manifests are in recommended sections
- You will be notified about installing them when you open project
- Settings
- All settings are set to be compatible with Appveyor pipeline and upstream (official) repositories
- No need to worry about formating restrictions between repositories.
- All settings are set to be compatible with Appveyor pipeline and upstream (official) repositories
- Code snippets
-
Code snippets are templates that make it easier to enter repeating code patterns, such as loops or conditional-statements.
- You could use workspace wide code snippets for speed up manifest creating
- While editing json file write partitial name of snippet and press
tab
- Available Json snippets:
app
- Create default manifest structure
appArch
- Create default manifest structure with full acrchitecture
arch
- Create only architecture property with 64bit and 32bit
upAr
- Create autoupdate property with architecture
persistCheck
- Installer / pre_install script for checking if file is already persisted or need to be created
-
GitHub repository configuration.
workflows
folder- Linux (legacy) versionGitHub Actions configuration for automatic issue/PR/updates handling.
- Windows version of actions could be used for better and future proof implementation (seehttps://github.com/Ash258/Scoop-GithubActions/tree/master-win for updated configs)
CODEOWNERS
- Pull requests will request review for users defined in this file
PULL REQUEST TEMPLATE
- Prefilled pull request types with proper titles
ISSUE TEMPLATE
- The most used issue templates for users to select and prefilled with required information and labels
.appveyor.yml
- Definition of Appveyor CI pipeline
.editorconfig
- Universal configuration file, compatible with all types of editors
- Defines how files should look
.gitattributes
- Simplifying line endings for git
- No need to configure
auto.clrf
setting on each clone or new workspaces
Bucket.Tests.ps1
- Test which are executed inside Appveyor pipeline
- Could be configured as
pre_commit
hook
-
Click on
Use this template
to create new repository in your account with same files -
Open project settings andgive your bucket in new name
-
Add proper description of repository
- Information about what type of manifests could be found here
-
Add
scoop-bucket
tag for repository- Your manifests will be automatically available athttps://scoop-docs.now.sh/apps/
-
Enable appveyor CI/CD
- Register / Login toAppveyor
- Click
New Project
- From Left Panel, choose your source control variant (Github)
- From Right Panel, choose repository with bucket and click
+ Add
- 🎉 Project created and ready to build 🎉
- Get Badge URL
- Open Appveyor Project settings
- Navigate to Badges
- Copy
Branch Sample markdown code
snippet for further usage- Only master branch is better, since you can freely test in other branches and do not mystificate users
- You could use alternative styles
-
Clone project into some folder
git clone https://github.com/USER/REPO.git MyAwesomeBucket
-
Open vscode with this clone
code MyAwesomeBucket
-
Configure remote repository
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:
git fetch --all
git checkout -B upstream-master -t upstream/master
- Do changes
git merge master
or create PR in github
-
Create proper README.md
- Open
README.template.md
- Replace all
%%templatestring%%
with real and according values- Replace appveyor status badge with yours
- Override this README with completed
README.template.md
- Remove template
README.template.md
- Open
-
Repository tweaks
- Open
.github\CODEOWNERS
and change@Ash258
to desired github username - Actions
- Open each file in
.github\workflows
and changeyouremail@email.com
with your email - Visithttps://github.com/Ash258/Scoop-GithubActions for more information
- Open each file in
- Open
-
🎉🎉 Everything set. High Quality bucket is ready for new users 🎉🎉