diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..bae9a6a --- /dev/null +++ b/.editorconfig @@ -0,0 +1,14 @@ +# EditorConfig is awesome: https://EditorConfig.org + +# top-most EditorConfig file +root = true + +[*] +charset = utf-8 +end_of_line = crlf +files.encoding = "utf8" +indent_size = 4 +indent_style = tab +insert_final_newline = true +max_line_length = 80 +trim_trailing_whitespace = true diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..992277d --- /dev/null +++ b/.gitattributes @@ -0,0 +1,9 @@ + +* text=auto + +## Enforce text mode and CRLF line breaks +*.editorconfig text eol=crlf +*.gitattributes text eol=crlf +*.gitignore text eol=crlf +*.md text eol=crlf +*.txt text eol=crlf diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..a35bbb4 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,2 @@ + +#* @Gesugao-san diff --git a/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md similarity index 99% rename from CODE_OF_CONDUCT.md rename to .github/CODE_OF_CONDUCT.md index 8793f8a..cd5ee87 100644 --- a/CODE_OF_CONDUCT.md +++ b/.github/CODE_OF_CONDUCT.md @@ -1,3 +1,4 @@ + # Contributor Covenant Code of Conduct ## Our Pledge diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..6e7a48f --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,27 @@ + +# CONTRIBUTING + +[Back](../README.md) + +> Guide to contributing to [foo/bar](https://github.com/foo/bar) repo. + +### Table of content +- [CONTRIBUTING](#contributing) + - [Table of content](#table-of-content) + - [Pull Request Process](#pull-request-process) + - [Banned content](#banned-content) + +## Pull Request Process + +There is no strict process when it comes to merging pull requests. Pull requests will sometimes take a while before they are looked at by a maintainer; the bigger the change, the more time it will take before they are accepted. + +Please feel free to: + * fix mistakes through a [Pull Requests (PR is short)](https://github.com/foo/bar/pulls). + +## Banned content + +Do not add any of the following in a Pull Request or risk getting the PR closed: + +* Code which violates GitHub's [terms of service](https://github.com/site/terms). + +--- diff --git a/.github/DOWNLOAD.md b/.github/DOWNLOAD.md new file mode 100644 index 0000000..08a4a25 --- /dev/null +++ b/.github/DOWNLOAD.md @@ -0,0 +1,34 @@ + +# DOWNLOADING + +[Back](../README.md) + +> Guide to download from [foo/bar](https://github.com/foo/bar) repo. + +### Table of content +- [DOWNLOADING](#downloading) + - [Table of content](#table-of-content) + - [Browser](#browser) + - [git bash](#git-bash) + +## Browser + +Download the source code as a zip by clicking the ZIP button in the code tab of https://github.com/foo/bar (note: this will use a lot of bandwidth if you wish to update and is a lot of hassle if you want to make any changes at all, so it's not recommended) + +![Browser download](/.github/static/browser_download.png) + +For more info check [official Github guide](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories), please. + +## git bash + +You can use any Git client to "clone" the repository, downloading a copy to your machine. You can also use Git to "pull", which updates your copy to match recent changes. + +```shell +$ git clone https://github.com/foo/bar +``` + +![Browser download](/.github/static/mintty_download.png) + +For more info check [official Github guide](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories), please. + +--- diff --git a/.github/TODO.md b/.github/TODO.md new file mode 100644 index 0000000..cea1d50 --- /dev/null +++ b/.github/TODO.md @@ -0,0 +1,17 @@ + +# TODO + +[Back](../README.md) + +> ToDo list. + +### Table of content + +- [TODO](#todo) + - [Table of content](#table-of-content) + - [ToDo table](#todo-table) + +## ToDo table + +- [ ] ~~Example entry (not marked as done)~~; +- [x] ~~Example entry (marked as done)~~. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 6a1cc4c..5309a24 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,5 +1,6 @@ -** Changes ** -A brief description of the changes + +**Changes** +A brief description of the changes. 1. Did X 2. Tested Y diff --git a/.github/static/License-MIT-yellow.svg b/.github/static/License-MIT-yellow.svg new file mode 100644 index 0000000..d298100 --- /dev/null +++ b/.github/static/License-MIT-yellow.svg @@ -0,0 +1 @@ +License: MITLicenseMIT \ No newline at end of file diff --git a/.github/static/Made_in-VS_Code-1f425f.svg b/.github/static/Made_in-VS_Code-1f425f.svg new file mode 100644 index 0000000..5485170 --- /dev/null +++ b/.github/static/Made_in-VS_Code-1f425f.svg @@ -0,0 +1 @@ +Made in: VS CodeMade inVS Code \ No newline at end of file diff --git a/.github/static/browser_download.png b/.github/static/browser_download.png new file mode 100644 index 0000000..7a6fbb9 Binary files /dev/null and b/.github/static/browser_download.png differ diff --git a/.github/static/mintty_download.png b/.github/static/mintty_download.png new file mode 100644 index 0000000..e15ff65 Binary files /dev/null and b/.github/static/mintty_download.png differ diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml new file mode 100644 index 0000000..10a4958 --- /dev/null +++ b/.github/workflows/main.yml @@ -0,0 +1,50 @@ +# This is a basic workflow to help you get started with Actions + +name: "CI Template" + +# Controls when the action will run. +on: + # Triggers the workflow on push or pull request events but only for the master branch + push: + branches: [ master ] + pull_request: + branches: [ master ] + #types: [opened, synchronize, closed] + + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +# A workflow run is made up of one or more jobs that can run sequentially or in parallel +jobs: + ci_job_cancel_test_win: + name: CI job cancel test (OS Windows) + runs-on: windows-latest + steps: + - name: Job cancel + shell: cmd + run: | + ECHO Hello world! + ECHO ---------------------------------------- + EXIT 0 + + ci_job_cancel_test_lin: + name: CI job cancel test (OS *nux) + runs-on: ubuntu-latest + steps: + - name: Job cancel + shell: bash + run: | + echo "Hello world!" + echo "----------------------------------------" + exit 0 + + ci_job_cancel_test_mac: + name: CI job cancel test (macOS) + runs-on: macos-latest + steps: + - name: Job cancel + shell: sh + run: | + echo "Hello world!" + echo "----------------------------------------" + exit 0 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..b16b0d5 --- /dev/null +++ b/.gitignore @@ -0,0 +1,49 @@ + +# File created using '.gitignore Generator' for Visual Studio Code: https://bit.ly/vscode-gig + +# Created by https://www.toptal.com/developers/gitignore/api/windows,visualstudiocode +# Edit at https://www.toptal.com/developers/gitignore?templates=windows,visualstudiocode + +### VisualStudioCode ### +.vscode/* +!.vscode/settings.json +!.vscode/tasks.json +!.vscode/launch.json +!.vscode/extensions.json +*.code-workspace + +### VisualStudioCode Patch ### +# Ignore all local history of files +.history +.ionide + +### Windows ### +# Windows thumbnail cache files +Thumbs.db +Thumbs.db:encryptable +ehthumbs.db +ehthumbs_vista.db + +# Dump file +*.stackdump + +# Folder config file +[Dd]esktop.ini + +# Recycle Bin used on file shares +$RECYCLE.BIN/ + +# Windows Installer files +*.cab +*.msi +*.msix +*.msm +*.msp + +# Windows shortcuts +*.lnk + +# End of https://www.toptal.com/developers/gitignore/api/windows,visualstudiocode + +# Custom rules (everything added below won't be overriden by 'Generate .gitignore File' if you use 'Update' option) + diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 0000000..ecbab66 --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,21 @@ +{ + "recommendations": [ + "andreabbondanza.ignoregit", + "codezombiech.gitignore", + "eamodio.gitlens", + "github.vscode-pull-request-github", + "ibm.output-colorizer", + "icrawl.discord-vscode", + "jasonnutter.vscode-codeowners", + "knisterpeter.vscode-github", + "oderwat.indent-rainbow", + "pflannery.vscode-versionlens", + "piotrpalarz.vscode-gitignore-generator", + "shan.code-settings-sync", + "shd101wyy.markdown-preview-enhanced", + "usernamehw.errorlens", + "wwm.better-align", + "xshrim.txt-syntax", + "yzhang.markdown-all-in-one", + ] +} diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..7073c47 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,21 @@ +{ + "editor.detectIndentation": false, + "editor.insertSpaces": false, + "editor.tabSize": 4, + "files.encoding": "utf8", + "files.eol": "\r\n", + "files.insertFinalNewline": true, + "files.trimFinalNewlines": false, + "files.trimTrailingWhitespace": true, + "files.exclude": { + "**/.classpath": true, + "**/.DS_Store": true, + "**/.factorypath": true, + "**/.git": true, + "**/.hg": true, + "**/.project": true, + "**/.settings": true, + "**/.svn": true, + "**/CVS": true, + }, +} diff --git a/CODEOWNERS b/CODEOWNERS deleted file mode 100644 index ccc2de8..0000000 --- a/CODEOWNERS +++ /dev/null @@ -1 +0,0 @@ -* @BYOND/team-infrastructure diff --git a/LICENSE b/LICENSE index 20d6212..79788e0 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2020 BYOND +Copyright (c) 2021 Gesugao-san Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md new file mode 100644 index 0000000..b60ce0a --- /dev/null +++ b/README.md @@ -0,0 +1,67 @@ + +

+

+ Infrastructure template +

+

+ Origin: + + BYOND/infrastructure-template-repository + +

+

+ +

+ + + [Made in VS Code] + ˙ + + [License MIT] + +
+ + + [CI status] + ˙ + + [Last Commit] + +

+ +--- + +> [Lorem ipsum dolor sit amet, consectetur adipiscing elit. Duis scelerisque aliquam nibh, sed accumsan ipsum malesuada a. Mauris a facilisis erat. ](https://lipsum.com/) + +## Table of Contents + +- [Table of Contents](#table-of-contents) +- [Details](#details) +- [For contributors](#for-contributors) + +## Details + +
+ [ Click on me ] + Hello there! +
+ +## For contributors + + 1. [Contributing](./.github/CONTRIBUTING.md) + 1. [ToDo list](./.github/TODO.md) + 1. [Download](./.github/DOWNLOAD.md) + +--- + +

+ +

diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 935be02..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,14 +0,0 @@ -# Security Policy - -## Supported Versions - -We currently support only the latest version, as this is organisational infrastructure. - -| Version | Supported | -| ------- | ------------------ | -| latest | :white_check_mark: | -| other | :x: | - -## Reporting a Vulnerability - -To report a vulnerability, you can email [Stephen001](mailto:stephen001@byondlabs.io) and include "[SECURITY]" and the name of the repository in the title of the email. Once triaged, a summarised issue will be created in the repository that you can subscribe to for updates.