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.

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

Fix workflows #26

Merged
merged 2 commits into from
Sep 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 1 addition & 7 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,21 +14,15 @@ jobs:
uses: actions/setup-go@v4
with:
go-version: "1.22.x"

- name: Go Environment
run: go env

- name: Verify Go Modules
run: go mod verify

- name: Build
run: go build -v ./...

run: go build -v ./cmd/hype/
- name: Run tests with Race Detector
run: go test -race -vet=off ./...

- name: Install staticcheck
run: go install honnef.co/go/tools/cmd/staticcheck@latest

- name: Run staticcheck
run: staticcheck ./...
20 changes: 14 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,8 @@ func main() {
fmt.Println("Hello World")
}
```
> *source: docs/quickstart/src/hello/main.go:example*


A `snippet` is not required in your `code` tag. The default behavior of a `code` tag is to include the entire source file.

Expand All @@ -96,9 +98,9 @@ import "fmt"
func main() {
fmt.Println("Hello World")
}


```
> *source: docs/quickstart/src/hello/main.go*


Notice that none of the `snippet` comments were in the output? This is because hype recognizes them as directives for the document, and will not show them in the actual output.

Expand Down Expand Up @@ -146,9 +148,9 @@ import "fmt"
func main() {
fmt.Println("Hello World")
}


```
> *source: docs/quickstart/src/hello/main.go*


---

Expand Down Expand Up @@ -176,6 +178,8 @@ func main() {
fmt.Println("Hello World")
}
```
> *source: docs/quickstart/src/hello/main.go#example:example*


---

Expand Down Expand Up @@ -203,6 +207,8 @@ func main() {
fmt.Prin("Hello World")
}
```
> *source: docs/quickstart/src/broken/main.go#example:example*


---

Expand Down Expand Up @@ -340,8 +346,9 @@ The following code will parse the code/code.md and sourceable/sourceable.md docu
<include src="code/code.md"></include>

<include src="sourceable/sourceable.md"></include>

```
> *source: docs/quickstart/includes.md*


---

Expand Down Expand Up @@ -1289,8 +1296,9 @@ jobs:
git config user.email 'actions@github.com'
git diff --quiet || (git add README.md && git commit -am "Updated README")
git push origin ${{github.event.pull_request.head.ref}}

```
> *source: .github/workflows/hype.yml*


---

Expand Down