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

refactor: consolidate workflows #78

Merged
merged 1 commit into from
Feb 29, 2024
Merged

refactor: consolidate workflows #78

merged 1 commit into from
Feb 29, 2024

Conversation

trym-b
Copy link
Contributor

@trym-b trym-b commented Feb 29, 2024

Motivation

To the workflows easier to work with, we should
use the jobs parameter more often. Especially
when the triggers are the same.

This makes it easier to inspect the various jobs
as they are now mostly in the same workflows.

In addition, there should be dependencies between
the various jobs, for example, so that the tests
run on the actual release. Or not to automatically release if the lint job fails.

Changes

  • release.yml is renamed to main.yml
  • The jobs of test.yml, and lint.yml have now also moved to main.yml.
  • The job goreleaser has now been renamed to Build, as it reflects what it does better (nothing is actually released, and goreleaser is just an implementation detail).

Future work

github-pages could also potentially be moved to
main.yml, but because the triggers are different it has been left out for now.

# Motivation

To the workflows easier to work with, we should
use the `jobs` parameter more often. Especially
when the triggers are the same.

This makes it easier to inspect the various jobs
as they are now mostly in the same workflows.

In addition, there should be dependencies between
the various jobs, for example, so that the tests
run on the actual release. Or not to automatically
release if the `lint` job fails.

# Changes

* `release.yml` is renamed to `main.yml`
* The jobs of `test.yml`, and `lint.yml` have now
also moved to `main.yml`.
* The job `goreleaser` has now been renamed to
  `Build`, as it reflects what it does better
  (nothing is actually released, and `goreleaser`
  is just an implementation detail).

# Future work

`github-pages` could also potentially be moved to
`main.yml`, but because the triggers are different
it has been left out for now.
Copy link
Member

@maeb maeb left a comment

Choose a reason for hiding this comment

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

LGTM

@trym-b trym-b merged commit 9be3c34 into main Feb 29, 2024
4 checks passed
@trym-b trym-b deleted the refactor/rename-workflows branch February 29, 2024 14:46
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.

2 participants