diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..c8db545 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,13 @@ +# Change + +## Issues + +- #{FIXME} + +## Summary + +{FIXME} + +## Changes in action + +{FIXME} diff --git a/.github/workflows/always.yml b/.github/workflows/always.yml new file mode 100644 index 0000000..0c8ab13 --- /dev/null +++ b/.github/workflows/always.yml @@ -0,0 +1,14 @@ +name: "[C]ontinuous [I]ntegration" +on: + push: + workflow_dispatch: # Allows you to run this workflow manually from the Actions tab + +concurrency: + group: ${{ github.ref }}-${{ github.workflow }} + cancel-in-progress: true + +jobs: + lint: + uses: percebus/github-actions-npm/.github/workflows/npm_run_script.yml@main + with: + script: lint diff --git a/.github/workflows/pull_request.yml b/.github/workflows/pull_request.yml new file mode 100644 index 0000000..c4cb9a9 --- /dev/null +++ b/.github/workflows/pull_request.yml @@ -0,0 +1,18 @@ +name: Pull Request + +# "This run was triggered by the "push" event, which is unsupported. +# Please ensure you are using the "pull_request" event for this workflow." +on: + pull_request: + +concurrency: + group: ${{ github.ref }}-${{ github.workflow }} + cancel-in-progress: true + +permissions: + contents: read + pull-requests: read + +jobs: + audit: + uses: percebus/github-actions-npm/.github/workflows/dependency-review.yml@main diff --git a/.gitignore b/.gitignore index 9a5aced..4c57fdf 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,24 @@ + +################################## +### VisualStudioCode.gitignore ### SRC: https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore +################################## + +.vscode/* +!.vscode/settings.json +!.vscode/tasks.json +!.vscode/launch.json +!.vscode/extensions.json +!.vscode/*.code-snippets +!*.code-workspace + +# Built Visual Studio Code Extensions +*.vsix + + +###################### +### Node.gitignore ### SRC: https://github.com/github/gitignore/blob/main/Node.gitignore +###################### + # Logs logs *.log diff --git a/LICENSE b/LICENSE.md similarity index 98% rename from LICENSE rename to LICENSE.md index fdddb29..f5f68e3 100644 --- a/LICENSE +++ b/LICENSE.md @@ -1,3 +1,5 @@ +# The UnLicense + This is free and unencumbered software released into the public domain. Anyone is free to copy, modify, publish, use, compile, sell, or diff --git a/README.md b/README.md index 03adc2a..3ab8864 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,45 @@ # github-actions + +[![[C]ontinuous [I]ntegration](https://github.com/percebus/github-actions/actions/workflows/always.yml/badge.svg)](https://github.com/percebus/github-actions/actions/workflows/always.yml) [![Pull Request](https://github.com/percebus/github-actions/actions/workflows/pull_request.yml/badge.svg?event=pull_request)](https://github.com/percebus/github-actions/actions/workflows/pull_request.yml) + GitHub re-usable Actions & Workflows + +## Repositories + +### Common + +| Name | naming | CI | CodeQL | dependency-review | pull_request | Trigger 1x | Tests | semantic-release | +| ----------------------------------------------------------- | ------ | --- | ------ | ----------------- | ------------ | ---------- | ----- | ---------------- | +| [common](https://github.com/percebus/github-actions-common) | ✅ | ✅ | ❌ | ✅ | same | ❌ | ✅ | ❌ | + +### Node.js + +| Name | naming | CI | CodeQL | dependency-review | pull_request | Trigger 1x | Tests | semantic-release | +| ------------------------------------------------------- | ------ | --- | ------ | ----------------- | ------------ | ---------- | ----- | ---------------- | +| [node](https://github.com/percebus/github-actions-node) | ✅ | ✅ | ❌ | N/A | ⚠️ | ✅ | ✅ | ❌ | +| [npm](https://github.com/percebus/github-actions-npm) | ❌ | ✅ | ❌ | ✅ | ✅ | ❌ | ✅ | ❌ | +| [nvm](https://github.com/percebus/github-actions-nvm) | ✅ | ✅ | ❌ | N/A | ⚠️ | ✅ | ✅ | ❌ | +| [yarn](https://github.com/percebus/github-actions-yarn) | ✅ | ✅ | ❌ | ✅ | ✅ | ❌ | ✅ | ❌ | + +### Python + +| Name | naming | CI | CodeQL | dependency-review | pull_request | Trigger 1x | Tests | semantic-release | +| ----------------------------------------------------------- | ------ | --- | ------ | ----------------- | ------------ | ---------- | ----- | ---------------- | +| [python](https://github.com/percebus/github-actions-python) | ✅ | ✅ | ❌ | N/A | ❌ | ❌ | ✅ | ❌ | +| [pip](https://github.com/percebus/github-actions-pip) | ✅ | ✅ | ❌ | ❔ | ❌ | ✅ | ✅ | ❌ | +| [pipx](https://github.com/percebus/github-actions-pipx) | ✅ | ✅ | ❌ | ❌ | ❌ | ✅ | ✅ | ❌ | +| [poetry](https://github.com/percebus/github-actions-poetry) | ✅ | ✅ | ❌ | N/A | ❌ | ❌ | ✅ | ❌ | +| [uv](https://github.com/percebus/github-actions-uv) | ✅ | ✅ | ❌ | N/A | ❌ | ✅ | ✅ | ❌ | + +### Containerization + +| Name | naming | CI | CodeQL | dependency-review | pull_request | Trigger 1x | Tests | semantic-release | +| ------------------------------------------------------------------------------- | ------ | --- | ------ | ----------------- | ------------ | ---------- | ----- | ---------------- | +| [containerization](https://github.com/percebus/github-actions-containerization) | ✅ | ✅ | ❌ | ❔ | ❌ | ❌ | ✅ | ❌ | +| [docker](https://github.com/percebus/github-actions-docker) | ❌ | ✅ | ❌ | ❔ | ❌ | | ✅ | ❌ | + +### Testing + +| Name | naming | CI | CodeQL | dependency-review | pull_request | Trigger 1x | Tests | semantic-release | +| ------------------------------------------------------------- | ------ | --- | ------ | ----------------- | ------------ | ---------- | ----- | ---------------- | +| [testing](https://github.com/percebus/github-actions-testing) | ✅ | ✅ | ❌ | N/A | ✅ | ❌ | ✅ | ❌ | diff --git a/TODO.md b/TODO.md new file mode 100644 index 0000000..0de623c --- /dev/null +++ b/TODO.md @@ -0,0 +1,5 @@ +# github-actions + +## TODOs + +- [ ] Rename repo to "devops" and also document repo "commons"? diff --git a/package-lock.json b/package-lock.json new file mode 100644 index 0000000..fdc9998 --- /dev/null +++ b/package-lock.json @@ -0,0 +1,32 @@ +{ + "name": "github-actions", + "version": "0.1.0", + "lockfileVersion": 3, + "requires": true, + "packages": { + "": { + "name": "github-actions", + "version": "0.1.0", + "license": "SEE LICENSE IN LICENSE.md", + "devDependencies": { + "prettier": "^3.6.2" + } + }, + "node_modules/prettier": { + "version": "3.6.2", + "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.6.2.tgz", + "integrity": "sha512-I7AIg5boAr5R0FFtJ6rCfD+LFsWHp81dolrFD8S79U9tb8Az2nGrJncnMSnys+bpQJfRUzqs9hnA81OAA3hCuQ==", + "dev": true, + "license": "MIT", + "bin": { + "prettier": "bin/prettier.cjs" + }, + "engines": { + "node": ">=14" + }, + "funding": { + "url": "https://github.com/prettier/prettier?sponsor=1" + } + } + } +} diff --git a/package.json b/package.json new file mode 100644 index 0000000..70becc2 --- /dev/null +++ b/package.json @@ -0,0 +1,34 @@ +{ + "name": "github-actions", + "version": "0.1.0", + "description": "GitHub re-usable Actions & Workflows", + "main": "index.js", + "scripts": { + "_prettier": "prettier .", + "prettier:write": "npm run _prettier -- --write", + "prettier:check": "npm run _prettier -- --check", + "lint": "npm run prettier:check", + "style": "npm run prettier:write", + "poststyle": "npm run lint", + "pretest": "npm run lint", + "test": "exit 0" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/percebus/github-actions.git" + }, + "keywords": [ + "GitHub", + "actions", + "workflows" + ], + "author": "JCystems", + "license": "SEE LICENSE IN LICENSE.md", + "bugs": { + "url": "https://github.com/percebus/github-actions/issues" + }, + "homepage": "https://github.com/percebus/github-actions#readme", + "devDependencies": { + "prettier": "^3.6.2" + } +}