Compare commits

24 Commits
v0.2.0 ... main

Author SHA1 Message Date
Nick Alteen
ba907d0898 Merge pull request #33 from actions/dependabot/github_actions/issue-ops/releaser-3
Some checks failed
Continuous Integration / Test Container Image (push) Has been cancelled
Lint Codebase / Lint Codebase (push) Has been cancelled
Bump issue-ops/releaser from 2 to 3
2026-02-18 16:01:58 -05:00
Nick Alteen
d0b8c38526 Merge pull request #32 from actions/dependabot/github_actions/issue-ops/semver-3
Bump issue-ops/semver from 2 to 3
2026-02-18 16:01:41 -05:00
Nick Alteen
ffd91abcf3 Merge pull request #31 from actions/dependabot/docker/docker-minor-60be0b6e22
Bump alpine from 3.22 to 3.23 in the docker-minor group
2026-02-18 16:01:25 -05:00
dependabot[bot]
e65a8c9b29 Bump issue-ops/releaser from 2 to 3
Bumps [issue-ops/releaser](https://github.com/issue-ops/releaser) from 2 to 3.
- [Release notes](https://github.com/issue-ops/releaser/releases)
- [Commits](https://github.com/issue-ops/releaser/compare/v2...v3)

---
updated-dependencies:
- dependency-name: issue-ops/releaser
  dependency-version: '3'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-12-08 11:07:41 +00:00
dependabot[bot]
2ad4f3be86 Bump issue-ops/semver from 2 to 3
Bumps [issue-ops/semver](https://github.com/issue-ops/semver) from 2 to 3.
- [Release notes](https://github.com/issue-ops/semver/releases)
- [Commits](https://github.com/issue-ops/semver/compare/v2...v3)

---
updated-dependencies:
- dependency-name: issue-ops/semver
  dependency-version: '3'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-12-08 11:07:38 +00:00
dependabot[bot]
5cf4dbe489 Bump alpine from 3.22 to 3.23 in the docker-minor group
Bumps the docker-minor group with 1 update: alpine.


Updates `alpine` from 3.22 to 3.23

---
updated-dependencies:
- dependency-name: alpine
  dependency-version: '3.23'
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: docker-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-12-08 11:07:25 +00:00
Nick Alteen
c7cac56ba1 Merge pull request #30 from actions/dependabot/github_actions/actions/checkout-6
Bump actions/checkout from 5 to 6
2025-12-05 11:50:08 -05:00
Nick Alteen
278f37da10 Add non-root user 2025-12-05 11:29:04 -05:00
Nick Alteen
c6338c4a08 Disable unused linters 2025-12-05 11:28:46 -05:00
dependabot[bot]
67213a44dc Bump actions/checkout from 5 to 6
Bumps [actions/checkout](https://github.com/actions/checkout) from 5 to 6.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](https://github.com/actions/checkout/compare/v5...v6)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-version: '6'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-11-24 11:43:26 +00:00
Nick Alteen
6290ac79d4 Merge pull request #29 from actions/dependabot/github_actions/actions/github-script-8
Bump actions/github-script from 7 to 8
2025-09-09 14:30:41 -04:00
dependabot[bot]
d28110fc9a Bump actions/github-script from 7 to 8
Bumps [actions/github-script](https://github.com/actions/github-script) from 7 to 8.
- [Release notes](https://github.com/actions/github-script/releases)
- [Commits](https://github.com/actions/github-script/compare/v7...v8)

---
updated-dependencies:
- dependency-name: actions/github-script
  dependency-version: '8'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-09-08 11:25:07 +00:00
Nick Alteen
f37028c2c4 Merge pull request #28 from actions/dependabot/github_actions/actions/checkout-5
Bump actions/checkout from 4 to 5
2025-08-26 14:55:08 -04:00
Nick Alteen
00ec9e2cb5 Disable new linter 2025-08-26 14:46:19 -04:00
dependabot[bot]
797d1f00c7 Bump actions/checkout from 4 to 5
Bumps [actions/checkout](https://github.com/actions/checkout) from 4 to 5.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](https://github.com/actions/checkout/compare/v4...v5)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-version: '5'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-08-25 21:10:38 +00:00
Nick Alteen
8e492feecf Merge pull request #26 from actions/ncalteen/badges
fix: remove unnecessary badges from README
2025-08-05 13:30:59 -04:00
Nick Alteen
cf764c66e0 Merge branch 'main' into ncalteen/badges 2025-08-05 13:07:52 -04:00
Nick Alteen
6a013ee048 Merge pull request #27 from actions/dependabot/github_actions/super-linter/super-linter-8
Bump super-linter/super-linter from 7 to 8
2025-08-05 13:07:43 -04:00
dependabot[bot]
02d117a742 Bump super-linter/super-linter from 7 to 8
Bumps [super-linter/super-linter](https://github.com/super-linter/super-linter) from 7 to 8.
- [Release notes](https://github.com/super-linter/super-linter/releases)
- [Changelog](https://github.com/super-linter/super-linter/blob/main/CHANGELOG.md)
- [Commits](https://github.com/super-linter/super-linter/compare/v7...v8)

---
updated-dependencies:
- dependency-name: super-linter/super-linter
  dependency-version: '8'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-08-04 16:18:23 +00:00
Nick Alteen
12ac695772 fix: remove unnecessary badges from README 2025-07-17 13:26:28 -04:00
Nick Alteen
25b48344e9 Merge pull request #25 from actions/ncalteen/copilot
Add Copilot Configuration
2025-07-15 14:41:28 -04:00
Nick Alteen
29ab4f8513 Fix linting errors 2025-07-11 13:52:52 -04:00
Nick Alteen
1d215422d4 feat: add Copilot instructions and release notes guidelines; configure VSCode settings and MCP 2025-07-11 13:41:18 -04:00
Nick Alteen
dbf8325cd3 Update config and docs from template 2025-07-11 13:41:10 -04:00
12 changed files with 166 additions and 17 deletions

4
.checkov.yaml Normal file
View File

@@ -0,0 +1,4 @@
quiet: true
skip-check:
- CKV_DOCKER_2
- CKV_DOCKER_3

69
.github/copilot-instructions.md vendored Normal file
View File

@@ -0,0 +1,69 @@
# 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

View File

@@ -0,0 +1,34 @@
# 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

View File

@@ -35,14 +35,14 @@ jobs:
steps:
- name: Checkout
id: checkout
uses: actions/checkout@v4
uses: actions/checkout@v6
with:
fetch-tags: true
ref: main
- name: Check Version
id: version
uses: issue-ops/semver@v2
uses: issue-ops/semver@v3
with:
check-only: true
manifest-path: ${{ env.MANIFEST_PATH }}
@@ -59,7 +59,7 @@ jobs:
# - `v1`
- name: Set Image Tags
id: tags
uses: actions/github-script@v7
uses: actions/github-script@v8
with:
script: |
const version = '${{ steps.version.outputs.version }}'
@@ -110,6 +110,6 @@ jobs:
- name: Create Release
id: release
uses: issue-ops/releaser@v2
uses: issue-ops/releaser@v3
with:
tag: v${{ steps.version.outputs.version }}

View File

@@ -2,6 +2,8 @@ name: Continuous Integration
on:
pull_request:
branches:
- main
push:
branches:
- main
@@ -27,7 +29,7 @@ jobs:
steps:
- name: Checkout
id: checkout
uses: actions/checkout@v4
uses: actions/checkout@v6
- name: Setup Docker BuildX
id: setup-buildx

View File

@@ -1,7 +1,14 @@
# 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
@@ -19,14 +26,18 @@ jobs:
steps:
- name: Checkout
id: checkout
uses: actions/checkout@v4
uses: actions/checkout@v6
with:
fetch-depth: 0
- name: Lint Codebase
id: super-linter
uses: super-linter/super-linter/slim@v7
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

View File

@@ -27,13 +27,13 @@ jobs:
steps:
- name: Checkout
id: checkout
uses: actions/checkout@v4
uses: actions/checkout@v6
with:
fetch-tags: true
- name: Check Version
id: check-version
uses: issue-ops/semver@v2
uses: issue-ops/semver@v3
with:
check-only: true
manifest-path: ${{ env.MANIFEST_PATH }}

1
.gitignore vendored
View File

@@ -21,5 +21,4 @@ Thumbs.db
# IDE files
.idea
.vscode
*.code-workspace

9
.vscode/mcp.json vendored Normal file
View File

@@ -0,0 +1,9 @@
{
"servers": {
"github": {
"url": "https://api.githubcopilot.com/mcp/",
"type": "http"
}
},
"inputs": []
}

15
.vscode/settings.json vendored Normal file
View File

@@ -0,0 +1,15 @@
{
"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." }
]
}

View File

@@ -1,5 +1,5 @@
# Set the base image to use for subsequent instructions.
FROM alpine:3.22
FROM alpine:3.23
# Set the working directory inside the container.
WORKDIR /usr/src
@@ -7,5 +7,12 @@ WORKDIR /usr/src
# Copy any source file(s) required for the action.
COPY entrypoint.sh .
# Create a non-root user and switch to it.
RUN addgroup -S actiongroup && adduser -S actionuser -G actiongroup && \
chown -R actionuser:actiongroup /usr/src && \
chmod +x /usr/src/entrypoint.sh
USER actionuser
# Configure the container to be run as an executable.
ENTRYPOINT ["/usr/src/entrypoint.sh"]

View File

@@ -1,8 +1,7 @@
# Container Prebuilt Action Template
# Create a Container Prebuilt Action
[![GitHub Super-Linter](https://github.com/actions/container-prebuilt-action/actions/workflows/linter.yml/badge.svg)](https://github.com/super-linter/super-linter)
![CI](https://github.com/actions/container-prebuilt-action/actions/workflows/ci.yml/badge.svg)
![CD](https://github.com/actions/container-prebuilt-action/actions/workflows/cd.yml/badge.svg)
![Continuous Integration](https://github.com/actions/container-prebuilt-action/actions/workflows/ci.yml/badge.svg)
Use this template to bootstrap the creation of a container action. :rocket:
@@ -177,7 +176,7 @@ So, what are you waiting for? Go ahead and start customizing your action!
Your action is now published! :rocket:
For information about versioning your action, see
[Versioning](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md)
[Versioning](https://github.com/actions/toolkit/blob/main/docs/action-versioning.md)
in the GitHub Actions toolkit.
## Releasing Versions
@@ -198,7 +197,7 @@ As part of the pull request, make sure to update the
After testing, you can create version tag(s) that developers can use to
reference different stable versions of your action. For more information, see
[Versioning](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md)
[Versioning](https://github.com/actions/toolkit/blob/main/docs/action-versioning.md)
in the GitHub Actions toolkit.
To include the action in a workflow in another repository, you can use the
@@ -209,7 +208,7 @@ hash.
steps:
- name: Checkout
id: checkout
uses: actions/checkout@v3
uses: actions/checkout@v4
- name: Test Local Action
id: test-action