diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json deleted file mode 100644 index b2dc827..0000000 --- a/.devcontainer/devcontainer.json +++ /dev/null @@ -1,40 +0,0 @@ -{ - "name": "GitHub Actions (Container)", - "image": "mcr.microsoft.com/devcontainers/base", - "customizations": { - "codespaces": { - "openFiles": ["README.md"] - }, - "vscode": { - "extensions": [ - "bierner.markdown-preview-github-styles", - "davidanson.vscode-markdownlint", - "esbenp.prettier-vscode", - "github.copilot", - "github.copilot-chat", - "github.vscode-github-actions", - "github.vscode-pull-request-github", - "me-dutour-mathieu.vscode-github-actions", - "ms-azuretools.vscode-docker", - "redhat.vscode-yaml", - "yzhang.markdown-all-in-one" - ], - "settings": { - "editor.defaultFormatter": "esbenp.prettier-vscode", - "editor.tabSize": 2, - "editor.formatOnSave": true, - "markdown.extension.list.indentationSize": "adaptive", - "markdown.extension.italic.indicator": "_", - "markdown.extension.orderedList.marker": "one" - } - } - }, - "remoteEnv": { - "GITHUB_TOKEN": "${localEnv:GITHUB_TOKEN}" - }, - "features": { - "ghcr.io/devcontainers/features/docker-in-docker:2": {}, - "ghcr.io/devcontainers/features/github-cli:1": {}, - "ghcr.io/devcontainers-community/npm-features/prettier:1": {} - } -} diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..c9ac640 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,18 @@ +# Default owners for everything + +* @NYU-ITS/research-technology-services + + +# Github settings + +.github/settings.yml @NYU-ITS/rts-codeowners + +# CODEOWNERS prevent renovate automerge since it will automatically ask for review + +# See documentation for more details: https://docs.renovatebot.com/automerge-configuration/ + +# Solution: make files used by renovate owned by everyone + +# example: +# **/*/package.json +# **/*/yarn.lock \ No newline at end of file diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md deleted file mode 100644 index e6630a8..0000000 --- a/.github/copilot-instructions.md +++ /dev/null @@ -1,69 +0,0 @@ -# Copilot Instructions - -This GitHub Action is written as a Docker container that invokes an entrypoint -script. The entrypoint script is responsible for invoking the main logic of the -action. - -## Repository Structure - -| Path | Description | -| -------------------- | ----------------------------------- | -| `.devcontainer/` | Development Container Configuration | -| `.github/` | GitHub Configuration | -| `.markdown-lint.yml` | Markdown Linter Configuration | -| `.prettierrc.yml` | Prettier Formatter Configuration | -| `.yaml-lint.yml` | YAML Linter Configuration | -| `action.yml` | GitHub Action Metadata | -| `CODEOWNERS` | Code Owners File | -| `Dockerfile` | Dockerfile for the Action | -| `entrypoint.sh` | Entrypoint Script | -| `LICENSE` | License File | -| `README.md` | Project Documentation | - -## General Coding Guidelines - -- Follow standard shell scripting conventions and best practices -- Changes should maintain consistency with existing patterns and style -- Document changes clearly and thoroughly, including updates to existing - comments when appropriate -- Do not include basic, unnecessary comments that simply restate what the code - is doing (focus on explaining _why_, not _what_) -- Use consistent error handling patterns throughout the codebase -- Keep functions focused and manageable -- Use descriptive variable and function names that clearly convey their purpose -- When suggesting code changes, always opt for the most maintainable approach. - Try your best to keep the code clean and follow "Don't Repeat Yourself" (DRY) - principles -- Avoid unnecessary complexity and always consider the long-term maintainability - of the code - -### Versioning - -GitHub Actions are versioned using branch and tag names. The version should -follow [Semantic Versioning](https://semver.org/) principles. - -## Pull Request Guidelines - -When creating a pull request (PR), please ensure that: - -- Keep changes focused and minimal (avoid large changes, or consider breaking - them into separate, smaller PRs) -- Formatting checks pass -- Linting checks pass -- If necessary, the `README.md` file is updated to reflect any changes in - functionality or usage - -The body of the PR should include: - -- A summary of the changes -- A special note of any changes to dependencies -- A link to any relevant issues or discussions -- Any additional context that may be helpful for reviewers - -## Code Review Guidelines - -When performing a code review, please follow these guidelines: - -- If there are changes that modify the functionality/usage of the action, - validate that there are changes in the `README.md` file that document the new - or modified functionality diff --git a/.github/linters/.checkov.yaml b/.github/linters/.checkov.yaml deleted file mode 100644 index c306051..0000000 --- a/.github/linters/.checkov.yaml +++ /dev/null @@ -1,6 +0,0 @@ -quiet: true -skip-check: - # Ensure that HEALTHCHECK instructions have been added to container images - - CKV_DOCKER_2 - # Ensure that a user for the container has been created - - CKV_DOCKER_3 diff --git a/.github/prompts/create-release-notes.prompt.md b/.github/prompts/create-release-notes.prompt.md deleted file mode 100644 index d5c7c0a..0000000 --- a/.github/prompts/create-release-notes.prompt.md +++ /dev/null @@ -1,34 +0,0 @@ -# Create Release Notes - -You are an expert technical writer tasked with creating release notes for -updates to this repository. Your specific task is to generate release notes that -are clear, concise, and useful for developers and users of the project. - -## Guidelines - -Ensure you adhere to the following guidelines when creating release notes: - -- Use a clear and consistent format for the release notes -- Include a summary of the changes made in the release -- Highlight any new features, improvements, or bugfixes -- If applicable, include instructions for upgrading or migrating to the new - version -- Use technical language that is appropriate for the audience, but avoid jargon - that may not be understood by all users -- Ensure that the release notes are easy to read and navigate -- Include relevant issue or PR numbers where applicable -- Use proper Markdown formatting -- Use code blocks for commands, configuration examples, or code changes -- Use note and warning callouts for important information - -## Versioning - -GitHub Actions are versioned using branch and tag names. The version in the -project's `package.json` should reflect the changes made in the codebase and -follow [Semantic Versioning](https://semver.org/) principles. Depending on the -nature of the changes, please make sure to adjust the release notes accordingly: - -- For **major** changes, include a detailed description of the breaking changes - and how users can adapt to them -- For **minor** changes, highlight new features and improvements -- For **patch** changes, focus on bugfixes and minor improvements diff --git a/.github/workflows/linter.yml b/.github/workflows/linter.yml deleted file mode 100644 index 26fd4f7..0000000 --- a/.github/workflows/linter.yml +++ /dev/null @@ -1,43 +0,0 @@ -# This workflow will lint the entire codebase using the -# `super-linter/super-linter` action. -# -# For more information, see the super-linter repository: -# https://github.com/super-linter/super-linter -name: Lint Codebase - -on: - pull_request: - branches: - - main - push: - branches: - - main - -permissions: - contents: read - packages: read - statuses: write - -jobs: - lint: - name: Lint Codebase - runs-on: ubuntu-latest - - steps: - - name: Checkout - id: checkout - uses: actions/checkout@v6 - with: - fetch-depth: 0 - - - name: Lint Codebase - id: super-linter - uses: super-linter/super-linter/slim@v8 - env: - DEFAULT_BRANCH: main - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - LINTER_RULES_PATH: ${{ github.workspace }} - VALIDATE_ALL_CODEBASE: false - VALIDATE_BIOME_FORMAT: false - VALIDATE_BIOME_LINT: false - VALIDATE_GITHUB_ACTIONS_ZIZMOR: false diff --git a/.github/workflows/yamllint.yml b/.github/workflows/yamllint.yml new file mode 100644 index 0000000..8301f28 --- /dev/null +++ b/.github/workflows/yamllint.yml @@ -0,0 +1,24 @@ +name: lint-yaml + +on: + pull_request: + branches: + - main + + +permissions: + contents: read + pull-requests: write + + +jobs: + yamllint: + name: runner / yamllint + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@7 + - name: yamllint + uses: reviewdog/action-yamllint@e02a49fdf53f51ddd8dfa89b09aa975043aeba38 #v1.23.0 + with: + github_token: ${{ secrets.github_token }} + reporter: github-pr-review # Change reporter. diff --git a/.vscode/mcp.json b/.vscode/mcp.json deleted file mode 100644 index 7d7a7c0..0000000 --- a/.vscode/mcp.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "servers": { - "github": { - "url": "https://api.githubcopilot.com/mcp/", - "type": "http" - } - }, - "inputs": [] -} diff --git a/.vscode/settings.json b/.vscode/settings.json deleted file mode 100644 index 390e031..0000000 --- a/.vscode/settings.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "github.copilot.chat.reviewSelection.instructions": [ - { - "text": "Review the code changes carefully before accepting them." - } - ], - "github.copilot.chat.commitMessageGeneration.instructions": [ - { - "text": "Use conventional commit message format." - } - ], - "github.copilot.chat.pullRequestDescriptionGeneration.instructions": [ - { "text": "Always include a list of key changes." } - ] -}