Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Modify workflow triggers and status badge #1251

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
+5 −2
Open

Modify workflow triggers and status badge #1251

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e9a6a66
Correst status badge in README.md
ScottBrenner Mar 9, 2025
5108f66
Update README.md
ScottBrenner Mar 9, 2025
45f2af7
Update docs-and-linting.yml
ScottBrenner Mar 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion .github/workflows/docs-and-linting.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
name: Render and Lint Documentation

on:
push:
branches: [ 'main' ]
tags: [ 'v*.*.*' ]
pull_request:
branches_ignore: []
branches: [ 'main' ]

jobs:
build:
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# OCI Image Format Specification

![GitHub Actions for Docs and Linting](https://img.shields.io/github/actions/workflow/status/opencontainers/image-spec/docs-and-linting.yml?branch=main&label=GHA%20docs%20and%20linting)
[![Render and Lint Documentation](https://github.com/opencontainers/image-spec/actions/workflows/docs-and-linting.yml/badge.svg?branch=main)](https://github.com/opencontainers/image-spec/actions/workflows/docs-and-linting.yml)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we're changing this (I would have also been fine with no change since shields.io seems a bit more flexible), lets pin to the push event:

Suggested change
[![Render and Lint Documentation](https://github.com/opencontainers/image-spec/actions/workflows/docs-and-linting.yml/badge.svg?branch=main)](https://github.com/opencontainers/image-spec/actions/workflows/docs-and-linting.yml)
[![Render and Lint Documentation](https://github.com/opencontainers/image-spec/actions/workflows/docs-and-linting.yml/badge.svg?branch=main&event=push)](https://github.com/opencontainers/image-spec/actions/workflows/docs-and-linting.yml)

![License](https://img.shields.io/github/license/opencontainers/image-spec)
[![Go Reference](https://pkg.go.dev/badge/github.com/opencontainers/image-spec.svg)](https://pkg.go.dev/github.com/opencontainers/image-spec)

Expand Down