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

Initial release #5

Merged
merged 24 commits into from
Sep 30, 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
6 changes: 3 additions & 3 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ jobs:
- id: stack
uses: freckle/stack-action@v5
with:
stack-yaml: ${{ matrix.stack-yaml }}
stack-arguments: --stack-yaml ${{ matrix.stack-yaml }}
- if: ${{ matrix.stack-yaml == 'stack.yaml' }}
uses: freckle/weeder-action@v2
with:
Expand All @@ -43,7 +43,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: haskell/actions/hlint-setup@v2
- uses: haskell/actions/hlint-run@v2
- uses: haskell-actions/hlint-setup@v2
- uses: haskell-actions/hlint-run@v2
with:
fail-on: warning
1 change: 0 additions & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ on:

jobs:
release:
if: false # Remove when ready to release
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
Expand Down
6 changes: 4 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
## [_Unreleased_](https://github.com/freckle/github-workflow-commands/compare/v__...main)
## [_Unreleased_](https://github.com/freckle/github-workflow-commands/compare/v0.0.0.0...main)

- Unreleased features
## [v0.0.0.0](https://github.com/freckle/github-workflow-commands/tree/v0.0.0.0)

First tagged release.
64 changes: 64 additions & 0 deletions README.lhs
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# github-workflow-commands

For printing workflow commands in GitHub Actions.

See [Workflow commands for GitHub Actions](https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions).

The code herein is based on [GitHub Actions Toolkit](https://github.com/actions/toolkit/tree/main/packages/core/src).

---

<!--
```haskell
module Main (main) where

import Prelude

import Text.Markdown.Unlit ()
```
-->

```haskell
import qualified GitHub.Workflow.Command.Annotation as GH
import Control.Lens
```

An annotation is at minimum just a string.

```haskell
example1 :: IO ()
example1 =
GH.printByteStringLn $
GH.error "Something failed."
```

An annotation can also include a location.

```haskell
someLocation :: GH.Location
someLocation =
GH.inFile "app.js"
& GH.position ?~
( GH.atLine 13
& GH.extent ?~ GH.ToLine 16
)
```

```haskell
example2 :: IO ()
example2 =
GH.printByteStringLn $
GH.warning "Something seems amiss here."
& GH.location ?~ someLocation
```

<!--
```haskell
main :: IO ()
main = example1 >> example2
```
-->

---

[CHANGELOG](./CHANGELOG.md) | [LICENSE](./LICENSE)
11 changes: 0 additions & 11 deletions README.md

This file was deleted.

1 change: 1 addition & 0 deletions README.md
154 changes: 128 additions & 26 deletions flake.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion flake.nix
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
fourmolu = freckle.fourmolu-0-13-x;

ghc = freckleLib.haskellBundle {
ghcVersion = "ghc-9-6-5";
ghcVersion = "ghc-9-6-6";
enableHLS = true;
};
};
Expand Down
Loading
Loading