From 713a08e9daf82c3b7b2901ea3f42ed84a0b00844 Mon Sep 17 00:00:00 2001 From: Junior Date: Tue, 10 Aug 2021 21:14:47 +0100 Subject: [PATCH] Add CodeQL and Test CI, cleanup readme --- .github/workflows/codeql-analysis.yml | 71 +++++++++++++++++++++++++++ .github/workflows/test.yml | 22 +++++++++ .npmignore | 1 + README.md | 24 +++++---- 4 files changed, 109 insertions(+), 9 deletions(-) create mode 100644 .github/workflows/codeql-analysis.yml create mode 100644 .github/workflows/test.yml create mode 100644 .npmignore diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml new file mode 100644 index 0000000..27917c4 --- /dev/null +++ b/.github/workflows/codeql-analysis.yml @@ -0,0 +1,71 @@ +# For most projects, this workflow file will not need changing; you simply need +# to commit it to your repository. +# +# You may wish to alter this file to override the set of languages analyzed, +# or to provide custom queries or build logic. +# +# ******** NOTE ******** +# We have attempted to detect the languages in your repository. Please check +# the `language` matrix defined below to confirm you have the correct set of +# supported CodeQL languages. +# +name: "CodeQL" + +on: + push: + branches: [ main ] + pull_request: + # The branches below must be a subset of the branches above + branches: [ main ] + schedule: + - cron: '29 1 * * 2' + +jobs: + analyze: + name: Analyze + runs-on: ubuntu-latest + permissions: + actions: read + contents: read + security-events: write + + strategy: + fail-fast: false + matrix: + language: [ 'javascript' ] + # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ] + # Learn more: + # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed + + steps: + - name: Checkout repository + uses: actions/checkout@v2 + + # Initializes the CodeQL tools for scanning. + - name: Initialize CodeQL + uses: github/codeql-action/init@v1 + with: + languages: ${{ matrix.language }} + # If you wish to specify custom queries, you can do so here or in a config file. + # By default, queries listed here will override any specified in a config file. + # Prefix the list here with "+" to use these queries and those in the config file. + # queries: ./path/to/local/query, your-org/your-repo/queries@main + + # Autobuild attempts to build any compiled languages (C/C++, C#, or Java). + # If this step fails, then you should remove it and run the build manually (see below) + - name: Autobuild + uses: github/codeql-action/autobuild@v1 + + # ℹī¸ Command-line programs to run using the OS shell. + # 📚 https://git.io/JvXDl + + # ✏ī¸ If the Autobuild fails above, remove it and uncomment the following three lines + # and modify them (or add more) to build your code if your project + # uses a compiled language + + #- run: | + # make bootstrap + # make release + + - name: Perform CodeQL Analysis + uses: github/codeql-action/analyze@v1 diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml new file mode 100644 index 0000000..6d887ce --- /dev/null +++ b/.github/workflows/test.yml @@ -0,0 +1,22 @@ +on: push + +jobs: + test: + runs-on: ubuntu-latest + + strategy: + matrix: + node-version: [12.x, 14.x, 16.x] + + steps: + - name: Checkout + uses: actions/checkout@v2 + - name: Use Node.js ${{ matrix.node-version }} + uses: actions/setup-node@v2 + with: + node-version: ${{ matrix.node-version }} + - name: Install dependencies + run: yarn --frozen-lockfile + - name: Lint + run: yarn lint + # - run: yarn test diff --git a/.npmignore b/.npmignore new file mode 100644 index 0000000..26f5c15 --- /dev/null +++ b/.npmignore @@ -0,0 +1 @@ +.github diff --git a/README.md b/README.md index 8b495f1..d95c154 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,11 @@ # channel-backup +![GitHub branch checks state](https://img.shields.io/github/checks-status/TinkerStorm/channel-backup/main) +![GitHub repo size](https://img.shields.io/github/repo-size/TinkerStorm/channel-backup) +![GitHub Repo stars](https://img.shields.io/github/stars/TinkerStorm/channel-backup?style=social) +![npm](https://img.shields.io/npm/v/channel-backup) +![node-current](https://img.shields.io/node/v/channel-backup) + A command line tool to help Community Managers keep their information channels updated. Notes on progress can be found on the [project board](https://github.com/TinkerStorm/channel-backup/projects/1) or on the [Discord channel](https://discord.gg/7k6uS7kw5k). @@ -29,7 +35,7 @@ Options ```json { - "$schema": "https://github.com/TinkerStorm/channel-backup/blob/main/schemas/config.json", + "$schema": "https://github.com/TinkerStorm/channel-backup/raw/main/schemas/config.json", "webhook": "https://discord.com/api/webhooks/:id/:token", "files": [ "./path/to/file.md", @@ -69,15 +75,15 @@ Options ## File Support - Images are attached as `{ attachment, name: "{name}.{ext}" }` - - !PNG - - !GIF - - !JPG / !JPEG + - PNG + - GIF + - JPG / JPEG - Structured files are sent as is - - !JSON - - !YAML / !YML - - !TXT / !MD *both treated as markdown* + - JSON + - YAML / YML + - TXT / MD *both treated as markdown* - Templates - > While there is no support for template engines like nunjucks, ejs or liquid - with the intention to move to plugins, these could become plugins themselves. The theorised event hooks / listeners will reinforce the design by having them listen for certain files (native file handlers will be included as standard but follow the same internal design as plugins - marked with `!`). + > While there is no support for template engines like nunjucks, ejs or liquid - with the intention to move to plugins, these could become plugins themselves. The theorised event hooks / listeners will reinforce the design by having them listen for certain files (native file handlers will be included as standard but follow the same internal design as plugins). --- @@ -93,4 +99,4 @@ Options ## License - [MIT](LICENSE) \ No newline at end of file +This package uses the [MIT](LICENSE) license. \ No newline at end of file