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

Break up stack-arguments, prep v5 #36

Merged
merged 10 commits into from
Feb 5, 2024
Merged

Break up stack-arguments, prep v5 #36

merged 10 commits into from
Feb 5, 2024

Conversation

pbrisbin
Copy link
Member

@pbrisbin pbrisbin commented Jan 30, 2024

Implement subcommand-specific options

66873d2

The stack-arguments option preceding this was too limited. It could be
used for global arguments to stack as well as arguments to stack build, this made it impossible to use the input consistently across all
stack commands we happen to invoke.

The new interface separates:

  • stack-arguments for globals arguments, used in all invocations from
  • stack-build-arguments for all stack build invocations from
  • stack-build-arguments-{step} for specific stack build invocations and, finally
  • stack-{subcommand}-arguments for other invocations

Fix workflows

e31a26f

  • Bump version of actions/cache used
  • Bump version of actions/checkout used
  • Trim trailing whitespace

Use correct name for macOS in comment

81b64a1

Exclude .git in source-hash

c974d19

We suspect including this is causing some churn in the hash when sources
haven't, in fact, changed.

Rewrite README

fafd74f

Rendered

  • Describe notable changes in v4 and v5

  • Move linter removal notes up to changes subsections

  • Tweak generate-matrix README section

  • Generate Inputs/Outputs sections

    To do so:

    npm instlal
    npm run readme
  • Polish action.yml

    • Improve descriptions
    • Don't add required: true when there is a default
    • Use required: false instead of default: ""

    These should all help the generated README look better.


@restyled-io restyled-io bot mentioned this pull request Jan 30, 2024
@pbrisbin

This comment was marked as outdated.

@pbrisbin pbrisbin changed the title pb/v5 Break up stack-arguments, prep v5 Jan 30, 2024
@deemp

This comment was marked as outdated.

@pbrisbin

This comment was marked as outdated.

@deemp

This comment was marked as outdated.

@pbrisbin

This comment was marked as outdated.

@deemp

This comment was marked as outdated.

@pbrisbin

This comment was marked as outdated.

@deemp

This comment was marked as outdated.

@deemp

This comment was marked as outdated.

@deemp

This comment was marked as outdated.

@deemp deemp mentioned this pull request Jan 31, 2024
@pbrisbin pbrisbin marked this pull request as ready for review February 1, 2024 19:43
deemp and others added 5 commits February 1, 2024 14:47
The `stack-arguments` option preceding this was too limited. It could be
used for global arguments to `stack` as well as arguments to `stack
build`, this made it impossible to use the input consistently across all
`stack` commands we happen to invoke.

The new interface separates:

- `stack-arguments` for globals arguments, used in all invocations from
- `stack-build-arguments` for all `stack build` invocations from
- `stack-build-arguments-{step}` for _specific_ `stack build` invocations and, finally
- `stack-{subcommand}-arguments` for other invocations
- Bump version of actions/cache used
- Bump version of actions/checkout used
- Trim trailing whitespace
We suspect including this is causing some churn in the hash when sources
haven't, in fact, changed.
- Describe notable changes in v4 and v5
- Move linter removal notes up to changes subsections
- Tweak generate-matrix README section
- Generate Inputs/Outputs sections

  To do so:

  ```console
  npm instlal
  npm run readme
  ```

- Polish `action.yml`

  - Improve descriptions
  - Don't add `required: true` when there is a default
  - Use `required: false` instead of `default: ""`

  These should all help the generated README look better.
@pbrisbin
Copy link
Member Author

pbrisbin commented Feb 1, 2024

OK, I think this is done and history polished.

@pbrisbin pbrisbin requested a review from stackptr February 1, 2024 19:52
@pbrisbin
Copy link
Member Author

pbrisbin commented Feb 1, 2024

Here is a PR (private) where I'm testing this branch: https://github.com/freckle/megarepo/pull/32653

@deemp
Copy link
Contributor

deemp commented Feb 1, 2024

Would you like to let other people comment on this PR? I can share a link to this PR on a Telegram group (~1.6K Haskellers).

package.json Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@pbrisbin
Copy link
Member Author

pbrisbin commented Feb 2, 2024

Would you like to let other people comment on this PR?

It can't hurt. Though I would make it clear the action implementation itself is a mess of shell code, it's just used for Haskell, so it might be more of a review of the interface than the diff, you know?

@deemp
Copy link
Contributor

deemp commented Feb 3, 2024

Seems like there are no suggestions from members of that group.

@pbrisbin
Copy link
Member Author

pbrisbin commented Feb 3, 2024

Thanks! Sorry this week go away from us, I'll try to merge early last week.

@pbrisbin pbrisbin requested a review from stackptr February 5, 2024 13:51
@pbrisbin pbrisbin merged commit 74eabac into main Feb 5, 2024
30 checks passed
@pbrisbin pbrisbin deleted the pb/v5 branch February 5, 2024 18:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants