What's Changed

Bug Fixes 🛠

• fix: remove unnecessary trailing newlines in markdown output by @tmknom in #153

Full Changelog: v0.6.0...v0.6.1

Installation

Official binaries can be downloaded from https://github.com/tmknom/actdocs/releases .
We support popular operating systems such as Linux, Windows, and macOS, as well as CPU architectures like amd64 and arm64.

Manual Installation

Download the binary for your operating system and architecture, make it executable, and move it to a directory in your PATH.
For example, on AMD64 Linux, run the following commands:

curl -sSL -o actdocs "https://github.com/tmknom/actdocs/releases/download/0.6.1/actdocs_0.6.1_linux_amd64"
chmod +x actdocs
sudo mv actdocs /usr/local/bin/actdocs

Homebrew Installation

brew install tmknom/tap/actdocs

DEB Installation

Download the .deb package for your architecture (e.g., *_linux_amd64.deb or *_linux_arm64.deb), then install it using the dpkg command:

curl -sSL -o actdocs.deb "https://github.com/tmknom/actdocs/releases/download/0.6.1/actdocs_0.6.1_linux_amd64.deb"
dpkg -i actdocs.deb

RPM Installation

Download the .rpm package for your architecture (e.g., *_linux_amd64.rpm or *_linux_arm64.rpm), then install it using the rpm command:

curl -sSL -o actdocs.rpm "https://github.com/tmknom/actdocs/releases/download/0.6.1/actdocs_0.6.1_linux_amd64.rpm"
rpm -ivh actdocs.rpm

APK Installation

Download the .apk package for your architecture (e.g., *_linux_amd64.apk or *_linux_arm64.apk), then install it using the apk command:

curl -sSL -o actdocs.apk "https://github.com/tmknom/actdocs/releases/download/0.6.1/actdocs_0.6.1_linux_amd64.apk"
apk add --allow-untrusted actdocs.apk

Verification

All artifacts are checksummed, and signed by Cosign using identity-based ("keyless") signing and transparency.

Checksum verification

1. Install GitHub CLI and Cosign if not already available.
2. Download all artifacts using GitHub CLI:

   gh release download v0.6.1

3. Verify the signature using:

   cosign verify-blob \
     --signature "actdocs_0.6.1_checksums.txt.sig" \
     --certificate "actdocs_0.6.1_checksums.txt.pem" \
     --certificate-oidc-issuer "https://token.actions.githubusercontent.com" \
     --certificate-identity "https://github.com/tmknom/release-workflows/.github/workflows/go.yml@92c6d4cead2f5f4b097425af15d7128ef2414d40" \
     --certificate-github-workflow-repository "tmknom/actdocs" \
     --certificate-github-workflow-sha "a7aa67f42b9a6349ad6cb971290c5e6149c7d43d" \
     "actdocs_0.6.1_checksums.txt"

4. Verify the checksum of the downloaded files using:

   sha256sum --ignore-missing -c "actdocs_0.6.1_checksums.txt"

   Ensure that the output indicates a valid match.

Cosign verification

You can verify all artifacts, such as executable binaries, Linux packages, checksum files, and SBOMs.
For example, the linux/amd64 binary:

1. Install Cosign if not already available.
2. Verify the signature using:

   cosign verify-blob \
     --signature "actdocs_0.6.1_linux_amd64.sig" \
     --certificate "actdocs_0.6.1_linux_amd64.pem" \
     --certificate-oidc-issuer "https://token.actions.githubusercontent.com" \
     --certificate-identity "https://github.com/tmknom/release-workflows/.github/workflows/go.yml@92c6d4cead2f5f4b097425af15d7128ef2414d40" \
     --certificate-github-workflow-repository "tmknom/actdocs" \
     --certificate-github-workflow-sha "a7aa67f42b9a6349ad6cb971290c5e6149c7d43d" \
     "actdocs_0.6.1_linux_amd64"

GitHub Artifact Attestations verification

You can verify all artifacts, such as executable binaries, Linux packages, checksum files, and SBOMs.
For example, the linux/amd64 binary:

1. Install GitHub CLI if not already available.
2. Verify the attestation:

   gh attestation verify "actdocs_0.6.1_linux_amd64" \
     --deny-self-hosted-runners \
     --repo "tmknom/actdocs" \
     --cert-oidc-issuer "https://token.actions.githubusercontent.com" \
     --cert-identity "https://github.com/tmknom/release-workflows/.github/workflows/go.yml@92c6d4cead2f5f4b097425af15d7128ef2414d40"

Container Images

• https://github.com/tmknom/actdocs/pkgs/container/actdocs

Pull image tag

docker pull ghcr.io/tmknom/actdocs:v0.6.1

Pull image digest

docker pull ghcr.io/tmknom/actdocs@sha256:987fc57319e05fb48041bcaa146fb44bab00f60e9adb3b187a31cf146241a868

Cosign verification

You can verify container images using Cosign.

1. Install Cosign if not already available.
2. Verify the signature using:

   cosign verify \
     --certificate-oidc-issuer "https://token.actions.githubusercontent.com" \
     --certificate-identity "https://github.com/tmknom/release-workflows/.github/workflows/go.yml@92c6d4cead2f5f4b097425af15d7128ef2414d40" \
     --certificate-github-workflow-repository "tmknom/actdocs" \
     --certificate-github-workflow-sha "a7aa67f42b9a6349ad6cb971290c5e6149c7d43d" \
     ghcr.io/tmknom/actdocs@sha256:987fc57319e05fb48041bcaa146fb44bab00f60e9adb3b187a31cf146241a868

GitHub Artifact Attestations verification

You can verify container images using GitHub Artifact Attestations.

1. Install GitHub CLI if not already available.
2. Verify the attestation:

   gh attestation verify oci://ghcr.io/tmknom/actdocs@sha256:987fc57319e05fb48041bcaa146fb44bab00f60e9adb3b187a31cf146241a868 \
     --deny-self-hosted-runners \
     --repo "tmknom/actdocs" \
     --cert-oidc-issuer "https://token.actions.githubusercontent.com" \
     --cert-identity "https://github.com/tmknom/release-workflows/.github/workflows/go.yml@92c6d4cead2f5f4b097425af15d7128ef2414d40"

What's Changed

Exciting New Features 🎉

• feat: standardize JSON output field names by introducing lowercase struct tags by @tmknom in #130
• feat: support section-based markdown injection for GitHub Actions custom actions by @tmknom in #151
• feat: support section-based markdown injection for GitHub Actions reusable workflows by @tmknom in #152

Bump Dependencies 🔥

• Bump actions/checkout from 3 to 4 by @dependabot in #96
• Bump github.com/google/go-cmp from 0.5.9 to 0.7.0 by @dependabot in #111
• Bump github.com/spf13/cobra from 1.6.1 to 1.9.1 by @dependabot in #110
• Bump actions/setup-go from 3 to 5 by @dependabot in #102
• Bump tmknom/release-workflows from 0.11.1 to 0.12.1 by @dependabot in #115

Full Changelog: v0.5.1...v0.6.0

Installation

Official binaries can be downloaded from https://github.com/tmknom/actdocs/releases .
We support popular operating systems such as Linux, Windows, and macOS, as well as CPU architectures like amd64 and arm64.

Manual Installation

Download the binary for your operating system and architecture, make it executable, and move it to a directory in your PATH.
For example, on AMD64 Linux, run the following commands:

curl -sSL -o actdocs "https://github.com/tmknom/actdocs/releases/download/0.6.0/actdocs_0.6.0_linux_amd64"
chmod +x actdocs
sudo mv actdocs /usr/local/bin/actdocs

Homebrew Installation

brew install tmknom/tap/actdocs

DEB Installation

Download the .deb package for your architecture (e.g., *_linux_amd64.deb or *_linux_arm64.deb), then install it using the dpkg command:

curl -sSL -o actdocs.deb "https://github.com/tmknom/actdocs/releases/download/0.6.0/actdocs_0.6.0_linux_amd64.deb"
dpkg -i actdocs.deb

RPM Installation

Download the .rpm package for your architecture (e.g., *_linux_amd64.rpm or *_linux_arm64.rpm), then install it using the rpm command:

curl -sSL -o actdocs.rpm "https://github.com/tmknom/actdocs/releases/download/0.6.0/actdocs_0.6.0_linux_amd64.rpm"
rpm -ivh actdocs.rpm

APK Installation

Download the .apk package for your architecture (e.g., *_linux_amd64.apk or *_linux_arm64.apk), then install it using the apk command:

curl -sSL -o actdocs.apk "https://github.com/tmknom/actdocs/releases/download/0.6.0/actdocs_0.6.0_linux_amd64.apk"
apk add --allow-untrusted actdocs.apk

Verification

All artifacts are checksummed, and signed by Cosign using identity-based ("keyless") signing and transparency.

Checksum verification

1. Install GitHub CLI and Cosign if not already available.
2. Download all artifacts using GitHub CLI:

   gh release download v0.6.0

3. Verify the signature using:

   cosign verify-blob \
     --signature "actdocs_0.6.0_checksums.txt.sig" \
     --certificate "actdocs_0.6.0_checksums.txt.pem" \
     --certificate-oidc-issuer "https://token.actions.githubusercontent.com" \
     --certificate-identity "https://github.com/tmknom/release-workflows/.github/workflows/go.yml@92c6d4cead2f5f4b097425af15d7128ef2414d40" \
     --certificate-github-workflow-repository "tmknom/actdocs" \
     --certificate-github-workflow-sha "9b9e9b86fd7485799183375237c99579f06a8709" \
     "actdocs_0.6.0_checksums.txt"

4. Verify the checksum of the downloaded files using:

   sha256sum --ignore-missing -c "actdocs_0.6.0_checksums.txt"

   Ensure that the output indicates a valid match.

Cosign verification

You can verify all artifacts, such as executable binaries, Linux packages, checksum files, and SBOMs.
For example, the linux/amd64 binary:

1. Install Cosign if not already available.
2. Verify the signature using:

   cosign verify-blob \
     --signature "actdocs_0.6.0_linux_amd64.sig" \
     --certificate "actdocs_0.6.0_linux_amd64.pem" \
     --certificate-oidc-issuer "https://token.actions.githubusercontent.com" \
     --certificate-identity "https://github.com/tmknom/release-workflows/.github/workflows/go.yml@92c6d4cead2f5f4b097425af15d7128ef2414d40" \
     --certificate-github-workflow-repository "tmknom/actdocs" \
     --certificate-github-workflow-sha "9b9e9b86fd7485799183375237c99579f06a8709" \
     "actdocs_0.6.0_linux_amd64"

GitHub Artifact Attestations verification

You can verify all artifacts, such as executable binaries, Linux packages, checksum files, and SBOMs.
For example, the linux/amd64 binary:

1. Install GitHub CLI if not already available.
2. Verify the attestation:

   gh attestation verify "actdocs_0.6.0_linux_amd64" \
     --deny-self-hosted-runners \
     --repo "tmknom/actdocs" \
     --cert-oidc-issuer "https://token.actions.githubusercontent.com" \
     --cert-identity "https://github.com/tmknom/release-workflows/.github/workflows/go.yml@92c6d4cead2f5f4b097425af15d7128ef2414d40"

Container Images

• https://github.com/tmknom/actdocs/pkgs/container/actdocs

Pull image tag

docker pull ghcr.io/tmknom/actdocs:v0.6.0

Pull image digest

docker pull ghcr.io/tmknom/actdocs@sha256:44c56bb8667125c4ddd04c10924ac4d05144e53d712299f1061c478464b758ca

Cosign verification

You can verify container images using Cosign.

1. Install Cosign if not already available.
2. Verify the signature using:

   cosign verify \
     --certificate-oidc-issuer "https://token.actions.githubusercontent.com" \
     --certificate-identity "https://github.com/tmknom/release-workflows/.github/workflows/go.yml@92c6d4cead2f5f4b097425af15d7128ef2414d40" \
     --certificate-github-workflow-repository "tmknom/actdocs" \
     --certificate-github-workflow-sha "9b9e9b86fd7485799183375237c99579f06a8709" \
     ghcr.io/tmknom/actdocs@sha256:44c56bb8667125c4ddd04c10924ac4d05144e53d712299f1061c478464b758ca

GitHub Artifact Attestations verification

You can verify container images using GitHub Artifact Attestations.

1. Install GitHub CLI if not already available.
2. Verify the attestation:

   gh attestation verify oci://ghcr.io/tmknom/actdocs@sha256:44c56bb8667125c4ddd04c10924ac4d05144e53d712299f1061c478464b758ca \
     --deny-self-hosted-runners \
     --repo "tmknom/actdocs" \
     --cert-oidc-issuer "https://token.actions.githubusercontent.com" \
     --cert-identity "https://github.com/tmknom/release-workflows/.github/workflows/go.yml@92c6d4cead2f5f4b097425af15d7128ef2414d40"

Changelog

• 57fcfa5 Merge pull request #95 from tmknom/bump-v0.5.1

Changelog

• 5f9f7e5 Merge pull request #91 from tmknom/fix-goreleaser

Changelog

NEW FEATURES

• Add support for description with action #82
• Add support for outputs with workflow #83
• Add support for permissions with workflow #85

Changelog

ENHANCEMENTS

• Add support for omit option #69

Changelog

NEW FEATURES

• Add support for inject command #56

ENHANCEMENTS

• Add support for format option #58
• Add support for dry run option #60
• Add support for secrets with workflow #65
• Add support for version option #50

Changelog

NEW FEATURES

• Add support for generate command #40

ENHANCEMENTS

• Add support for sort option #44
• Add support for sort-by-name option #42
• Add support for sort-by-required option #43

Changelog

• Initial release