Skip to content

Commit

Permalink
Fix status badge stuck on "Passing", hiding CI failures
Browse files Browse the repository at this point in the history
Was previously failing Go package self-test due to incorrect version
spec syntax in a914513, which had "go-version: '1.20'" in test.yml.

Generate documentation including goat SVG output used only for that
purpose on GitHub.  SVG output in examples/ continues to be checked in,
for regression-testing purposes.

Don't attempt to run the build in Windows.
  • Loading branch information
dmullis committed Jun 16, 2024
1 parent a914513 commit 291c861
Show file tree
Hide file tree
Showing 8 changed files with 59 additions and 663 deletions.
39 changes: 39 additions & 0 deletions .github/workflows/make.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: Make

on:
push:
pull_request:
branches: [main]

jobs:
build:
strategy:
matrix:
go-version: [1.21.x]
os: [ubuntu-latest]
runs-on: ${{ matrix.os }}

steps:
- name: Install Go
uses: actions/setup-go@v4
with:
go-version: ${{ matrix.go-version }}

- name: Checkout code
uses: actions/checkout@v3

- name: Make
run: ./make.sh

- name: Configure Git
run: |
git config --global user.name 'github-actions[bot]'
git config --global user.email 'github-actions[bot]@users.noreply.github.com'

- name: Commit and Push documentation
run: |
git add README.md goat.svg trees.mid-blue.svg
git commit -m 'Commit Github-generated documentation files'
git push
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
23 changes: 0 additions & 23 deletions .github/workflows/test.yml

This file was deleted.

270 changes: 0 additions & 270 deletions README.md

This file was deleted.

14 changes: 7 additions & 7 deletions README.md.tmpl
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# GoAT: Go ASCII Tool

<!-- Github-specific status icons-->
![](https://github.com/github/docs/actions/workflows/test.yml/badge.svg)
<!-- Github-specific status icon -->
![](https://github.com/{{.GithubActor}}/goat/actions/workflows/make.yml/badge.svg)

## What **GoAT** Can Do For You

Expand Down Expand Up @@ -42,7 +42,7 @@ with rows above and below.

## Installation
```
$ go install github.com/{{.GithubUser}}/goat/cmd/goat@latest
$ go install github.com/{{.GithubActor}}/goat/cmd/goat@latest
```
<!-- https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/organizing-information-with-collapsed-sections#creating-a-collapsed-section -->

Expand Down Expand Up @@ -133,12 +133,12 @@ The core engine of ```goat``` is accessible as a Go library package, for inclusi
code of your own.
The code implements a subset, and some extensions, of the ASCII diagram generation function of the browser-side Javascript in [Markdeep](http://casual-effects.com/markdeep/).

A nicely formatted reference may be found at [pkg.go.dev](https://pkg.go.dev/github.com/{{.GithubUser}}/goat).
A nicely formatted reference may be found at [pkg.go.dev](https://pkg.go.dev/github.com/{{.GithubActor}}/goat).

### Installation

```
$ go get -u github.com/{{.GithubUser}}/goat/
$ go get -u github.com/{{.GithubActor}}/goat/
```
### Library Data Flow
![]({{.Root}}/goat.svg)
Expand All @@ -150,13 +150,13 @@ source file [./goat.go](./goat.go).

<!--
XX XX May need a Github Action to do this substitution at "push" time.
[![resource non-responsive](https://pkg.go.dev/badge/github.com/{{.GithubUser}}/goat)](https://pkg.go.dev/github.com/{{.GithubUser}}/goat)
[![resource non-responsive](https://pkg.go.dev/badge/github.com/{{.GithubActor}}/goat)](https://pkg.go.dev/github.com/{{.GithubActor}}/goat)
-->

<!--
The scraping of GitHub by godocs.io (see https://sr.ht) does NOT include README.md;
whereas Google's pkg.go.dev does do so, and apparently runs its own variant of GFM processing :-/
[![resource non-responsive](https://godocs.io/github.com/{{.GithubUser}}/goat?status.svg)](https://godocs.io/github.com/{{.GithubUser}}/goat)
[![resource non-responsive](https://godocs.io/github.com/{{.GithubActor}}/goat?status.svg)](https://godocs.io/github.com/{{.GithubActor}}/goat)
-->

### Project Tenets
Expand Down
Loading

0 comments on commit 291c861

Please sign in to comment.