Skip to content

Register your Code Server deployment template repos into here.

License

Notifications You must be signed in to change notification settings

RecapTimeBot/template-registry

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Template registry for Code Server deployment template repos

File Structure

.
├── meta - Index of registered repos in YAML
└── scripts - Scripts for CI and stuff

How it's works?

  1. Register your template. Please fill up the issue template so humans can review it better in case automation went broken.
  2. Complete the prompts, like accepting the org invite and optionally transferring your repo into here. If automation/GitHub Actions is struggling on handling issues, please see this document
  3. Reply /register owner/repo (replacing owner/repo with your repo link without https://github.com/ path) so we can automatically add your repo into the registry.

Terms and conditions

  • By transferring your code-server template repo into this org, you agree to adopt our Community Code of Conduct. Your copyright will still be owned by you, just assigning additional people (contributors are included by default).
  • Your Dockerfiles and any bootstrapper scripts should be not includes anything related to crypto-mining, platform/service abuse, and scripts/software that may have illegal content (pirating and NSFW).

Available commands

You must be the issue author for these commands to work, otherwise the bot will delete the command you sent to avoid spam. Remember to prefix commands with / followed by an space. You cannot use these commands in the issue description, yet. (We're working on an Probot GitHub app for that.)

register

Description: Registers an repo into the registry. The bot will generate an random slug containing 3 words, seperated by dashes (e.g. require-build-confrim) but you can request an slug change. Private repos are not supported.

Arguments: owner/repo (required)

Example invocation:

/register cdr/deploy-code-server

unregister

Description: Removes an repo from the registry. Please use update if the repo has has been renamed or changed ownership/username. Once triggered, your issue is automatically assigned to Andrei Jiroh but any member of @code-server-boilerplates/maintainers and @code-server-boilerplates/contributors can assign to themselves and resolve the issue in case The Pins Team members are not available within 14 days.

Arguments: owner/repo|slug

Example invocation:

<!-- This doesn't work because it's belong into @code-server-boilerplates,
     and requires further assistance from org maintainers. -->
/unregister code-server-boilerplates/starter-pack

update

Description: Update repository links, in case the repo got renamed or changed owner's username or repo's ownership. Remember that requests for repository link update are reviewed on per-case basis and you cannot change repo link in the registry again for the next 30 days. You don't need to do this if you converted your account (we mean your username) into an GitHub org.

Arguments old-owner/old-repo new-owner/new-repo

Example invocation:

/update bcmpt/deploy-code-server cdr/deploy-code-server

request-slug

Description: Old slugs, including generated ones, are still active up to the day you unregister it from the registry. Remember that these are reviewed by an human, so be patient. If owner/repo or slug-name is only provided, automagically falls back to ussing slug generator.

Arguments: owner/repo|slug-here <random|user-defined-slug>

Example invocation:

<!-- Request an slug change with user-defined slug -->
/request-slug ThePinsTeam/deploy-code-server cdrs-internal-thepinsteam

<!-- Or probably let use do the work for you. -->
/request-slug code-server-boilerplates/nodejs-rust-mix

About

Register your Code Server deployment template repos into here.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Shell 100.0%